diff --git a/.tool-versions b/.tool-versions index dfaa2ae..3b16e3f 100644 --- a/.tool-versions +++ b/.tool-versions @@ -1 +1 @@ -nodejs 12.18.0 +nodejs 14.8.0 diff --git a/node_modules/@actions/core/README.md b/node_modules/@actions/core/README.md index 457f73c..95428cf 100644 --- a/node_modules/@actions/core/README.md +++ b/node_modules/@actions/core/README.md @@ -82,7 +82,14 @@ try { core.warning('myInput was not set'); } + if (core.isDebug()) { + // curl -v https://github.com + } else { + // curl https://github.com + } + // Do stuff + core.info('Output to the actions build log') } catch (err) { core.error(`Error ${err}, action may still succeed though`); @@ -137,4 +144,4 @@ const core = require('@actions/core'); var pid = core.getState("pidToKill"); process.kill(pid); -``` \ No newline at end of file +``` diff --git a/node_modules/@actions/core/lib/command.d.ts b/node_modules/@actions/core/lib/command.d.ts index 7f6fecb..89eff66 100644 --- a/node_modules/@actions/core/lib/command.d.ts +++ b/node_modules/@actions/core/lib/command.d.ts @@ -1,16 +1,16 @@ interface CommandProperties { - [key: string]: string; + [key: string]: any; } /** * Commands * * Command Format: - * ##[name key=value;key=value]message + * ::name key=value,key=value::message * * Examples: - * ##[warning]This is the user warning message - * ##[set-secret name=mypassword]definitelyNotAPassword! + * ::warning::This is the message + * ::set-env name=MY_VAR::some value */ -export declare function issueCommand(command: string, properties: CommandProperties, message: string): void; +export declare function issueCommand(command: string, properties: CommandProperties, message: any): void; export declare function issue(name: string, message?: string): void; export {}; diff --git a/node_modules/@actions/core/lib/command.js b/node_modules/@actions/core/lib/command.js index b0ea009..10bf3eb 100644 --- a/node_modules/@actions/core/lib/command.js +++ b/node_modules/@actions/core/lib/command.js @@ -1,15 +1,23 @@ "use strict"; +var __importStar = (this && this.__importStar) || function (mod) { + if (mod && mod.__esModule) return mod; + var result = {}; + if (mod != null) for (var k in mod) if (Object.hasOwnProperty.call(mod, k)) result[k] = mod[k]; + result["default"] = mod; + return result; +}; Object.defineProperty(exports, "__esModule", { value: true }); -const os = require("os"); +const os = __importStar(require("os")); +const utils_1 = require("./utils"); /** * Commands * * Command Format: - * ##[name key=value;key=value]message + * ::name key=value,key=value::message * * Examples: - * ##[warning]This is the user warning message - * ##[set-secret name=mypassword]definitelyNotAPassword! + * ::warning::This is the message + * ::set-env name=MY_VAR::some value */ function issueCommand(command, properties, message) { const cmd = new Command(command, properties, message); @@ -34,33 +42,38 @@ class Command { let cmdStr = CMD_STRING + this.command; if (this.properties && Object.keys(this.properties).length > 0) { cmdStr += ' '; + let first = true; for (const key in this.properties) { if (this.properties.hasOwnProperty(key)) { const val = this.properties[key]; if (val) { - // safely append the val - avoid blowing up when attempting to - // call .replace() if message is not a string for some reason - cmdStr += `${key}=${escape(`${val || ''}`)},`; + if (first) { + first = false; + } + else { + cmdStr += ','; + } + cmdStr += `${key}=${escapeProperty(val)}`; } } } } - cmdStr += CMD_STRING; - // safely append the message - avoid blowing up when attempting to - // call .replace() if message is not a string for some reason - const message = `${this.message || ''}`; - cmdStr += escapeData(message); + cmdStr += `${CMD_STRING}${escapeData(this.message)}`; return cmdStr; } } function escapeData(s) { - return s.replace(/\r/g, '%0D').replace(/\n/g, '%0A'); + return utils_1.toCommandValue(s) + .replace(/%/g, '%25') + .replace(/\r/g, '%0D') + .replace(/\n/g, '%0A'); } -function escape(s) { - return s +function escapeProperty(s) { + return utils_1.toCommandValue(s) + .replace(/%/g, '%25') .replace(/\r/g, '%0D') .replace(/\n/g, '%0A') - .replace(/]/g, '%5D') - .replace(/;/g, '%3B'); + .replace(/:/g, '%3A') + .replace(/,/g, '%2C'); } //# sourceMappingURL=command.js.map \ No newline at end of file diff --git a/node_modules/@actions/core/lib/command.js.map b/node_modules/@actions/core/lib/command.js.map index 918ab25..a95b303 100644 --- a/node_modules/@actions/core/lib/command.js.map +++ b/node_modules/@actions/core/lib/command.js.map @@ -1 +1 @@ -{"version":3,"file":"command.js","sourceRoot":"","sources":["../src/command.ts"],"names":[],"mappings":";;AAAA,yBAAwB;AAQxB;;;;;;;;;GASG;AACH,SAAgB,YAAY,CAC1B,OAAe,EACf,UAA6B,EAC7B,OAAe;IAEf,MAAM,GAAG,GAAG,IAAI,OAAO,CAAC,OAAO,EAAE,UAAU,EAAE,OAAO,CAAC,CAAA;IACrD,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC,CAAA;AAC/C,CAAC;AAPD,oCAOC;AAED,SAAgB,KAAK,CAAC,IAAY,EAAE,UAAkB,EAAE;IACtD,YAAY,CAAC,IAAI,EAAE,EAAE,EAAE,OAAO,CAAC,CAAA;AACjC,CAAC;AAFD,sBAEC;AAED,MAAM,UAAU,GAAG,IAAI,CAAA;AAEvB,MAAM,OAAO;IAKX,YAAY,OAAe,EAAE,UAA6B,EAAE,OAAe;QACzE,IAAI,CAAC,OAAO,EAAE;YACZ,OAAO,GAAG,iBAAiB,CAAA;SAC5B;QAED,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;QACtB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAA;QAC5B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;IACxB,CAAC;IAED,QAAQ;QACN,IAAI,MAAM,GAAG,UAAU,GAAG,IAAI,CAAC,OAAO,CAAA;QAEtC,IAAI,IAAI,CAAC,UAAU,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE;YAC9D,MAAM,IAAI,GAAG,CAAA;YACb,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,UAAU,EAAE;gBACjC,IAAI,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC,GAAG,CAAC,EAAE;oBACvC,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAA;oBAChC,IAAI,GAAG,EAAE;wBACP,8DAA8D;wBAC9D,6DAA6D;wBAC7D,MAAM,IAAI,GAAG,GAAG,IAAI,MAAM,CAAC,GAAG,GAAG,IAAI,EAAE,EAAE,CAAC,GAAG,CAAA;qBAC9C;iBACF;aACF;SACF;QAED,MAAM,IAAI,UAAU,CAAA;QAEpB,kEAAkE;QAClE,6DAA6D;QAC7D,MAAM,OAAO,GAAG,GAAG,IAAI,CAAC,OAAO,IAAI,EAAE,EAAE,CAAA;QACvC,MAAM,IAAI,UAAU,CAAC,OAAO,CAAC,CAAA;QAE7B,OAAO,MAAM,CAAA;IACf,CAAC;CACF;AAED,SAAS,UAAU,CAAC,CAAS;IAC3B,OAAO,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,CAAA;AACtD,CAAC;AAED,SAAS,MAAM,CAAC,CAAS;IACvB,OAAO,CAAC;SACL,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC;SACrB,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC;SACrB,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC;SACpB,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAA;AACzB,CAAC"} \ No newline at end of file +{"version":3,"file":"command.js","sourceRoot":"","sources":["../src/command.ts"],"names":[],"mappings":";;;;;;;;;AAAA,uCAAwB;AACxB,mCAAsC;AAWtC;;;;;;;;;GASG;AACH,SAAgB,YAAY,CAC1B,OAAe,EACf,UAA6B,EAC7B,OAAY;IAEZ,MAAM,GAAG,GAAG,IAAI,OAAO,CAAC,OAAO,EAAE,UAAU,EAAE,OAAO,CAAC,CAAA;IACrD,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC,CAAA;AAC/C,CAAC;AAPD,oCAOC;AAED,SAAgB,KAAK,CAAC,IAAY,EAAE,UAAkB,EAAE;IACtD,YAAY,CAAC,IAAI,EAAE,EAAE,EAAE,OAAO,CAAC,CAAA;AACjC,CAAC;AAFD,sBAEC;AAED,MAAM,UAAU,GAAG,IAAI,CAAA;AAEvB,MAAM,OAAO;IAKX,YAAY,OAAe,EAAE,UAA6B,EAAE,OAAe;QACzE,IAAI,CAAC,OAAO,EAAE;YACZ,OAAO,GAAG,iBAAiB,CAAA;SAC5B;QAED,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;QACtB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAA;QAC5B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;IACxB,CAAC;IAED,QAAQ;QACN,IAAI,MAAM,GAAG,UAAU,GAAG,IAAI,CAAC,OAAO,CAAA;QAEtC,IAAI,IAAI,CAAC,UAAU,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE;YAC9D,MAAM,IAAI,GAAG,CAAA;YACb,IAAI,KAAK,GAAG,IAAI,CAAA;YAChB,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,UAAU,EAAE;gBACjC,IAAI,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC,GAAG,CAAC,EAAE;oBACvC,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAA;oBAChC,IAAI,GAAG,EAAE;wBACP,IAAI,KAAK,EAAE;4BACT,KAAK,GAAG,KAAK,CAAA;yBACd;6BAAM;4BACL,MAAM,IAAI,GAAG,CAAA;yBACd;wBAED,MAAM,IAAI,GAAG,GAAG,IAAI,cAAc,CAAC,GAAG,CAAC,EAAE,CAAA;qBAC1C;iBACF;aACF;SACF;QAED,MAAM,IAAI,GAAG,UAAU,GAAG,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAA;QACpD,OAAO,MAAM,CAAA;IACf,CAAC;CACF;AAED,SAAS,UAAU,CAAC,CAAM;IACxB,OAAO,sBAAc,CAAC,CAAC,CAAC;SACrB,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC;SACpB,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC;SACrB,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,CAAA;AAC1B,CAAC;AAED,SAAS,cAAc,CAAC,CAAM;IAC5B,OAAO,sBAAc,CAAC,CAAC,CAAC;SACrB,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC;SACpB,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC;SACrB,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC;SACrB,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC;SACpB,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAA;AACzB,CAAC"} \ No newline at end of file diff --git a/node_modules/@actions/core/lib/core.d.ts b/node_modules/@actions/core/lib/core.d.ts index 6483c3c..8bb5093 100644 --- a/node_modules/@actions/core/lib/core.d.ts +++ b/node_modules/@actions/core/lib/core.d.ts @@ -21,9 +21,9 @@ export declare enum ExitCode { /** * Sets env variable for this action and future actions in the job * @param name the name of the variable to set - * @param val the value of the variable + * @param val the value of the variable. Non-string values will be converted to a string via JSON.stringify */ -export declare function exportVariable(name: string, val: string): void; +export declare function exportVariable(name: string, val: any): void; /** * Registers a secret which will get masked from logs * @param secret value of the secret @@ -46,15 +46,25 @@ export declare function getInput(name: string, options?: InputOptions): string; * Sets the value of an output. * * @param name name of the output to set - * @param value value to store + * @param value value to store. Non-string values will be converted to a string via JSON.stringify */ -export declare function setOutput(name: string, value: string): void; +export declare function setOutput(name: string, value: any): void; +/** + * Enables or disables the echoing of commands into stdout for the rest of the step. + * Echoing is disabled by default if ACTIONS_STEP_DEBUG is not set. + * + */ +export declare function setCommandEcho(enabled: boolean): void; /** * Sets the action status to failed. * When the action exits it will be with an exit code of 1 * @param message add error issue message */ -export declare function setFailed(message: string): void; +export declare function setFailed(message: string | Error): void; +/** + * Gets whether Actions Step Debug is on or not + */ +export declare function isDebug(): boolean; /** * Writes debug message to user log * @param message debug message @@ -62,14 +72,14 @@ export declare function setFailed(message: string): void; export declare function debug(message: string): void; /** * Adds an error issue - * @param message error issue message + * @param message error issue message. Errors will be converted to string via toString() */ -export declare function error(message: string): void; +export declare function error(message: string | Error): void; /** * Adds an warning issue - * @param message warning issue message + * @param message warning issue message. Errors will be converted to string via toString() */ -export declare function warning(message: string): void; +export declare function warning(message: string | Error): void; /** * Writes info to log with console.log. * @param message info message @@ -100,9 +110,9 @@ export declare function group(name: string, fn: () => Promise): Promise * Saves state for current action, the state can only be retrieved by this action's post job execution. * * @param name name of the state to store - * @param value value to store + * @param value value to store. Non-string values will be converted to a string via JSON.stringify */ -export declare function saveState(name: string, value: string): void; +export declare function saveState(name: string, value: any): void; /** * Gets the value of an state set by this action's main execution. * diff --git a/node_modules/@actions/core/lib/core.js b/node_modules/@actions/core/lib/core.js index f43d507..8b33110 100644 --- a/node_modules/@actions/core/lib/core.js +++ b/node_modules/@actions/core/lib/core.js @@ -8,10 +8,19 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge step((generator = generator.apply(thisArg, _arguments || [])).next()); }); }; +var __importStar = (this && this.__importStar) || function (mod) { + if (mod && mod.__esModule) return mod; + var result = {}; + if (mod != null) for (var k in mod) if (Object.hasOwnProperty.call(mod, k)) result[k] = mod[k]; + result["default"] = mod; + return result; +}; Object.defineProperty(exports, "__esModule", { value: true }); const command_1 = require("./command"); -const os = require("os"); -const path = require("path"); +const file_command_1 = require("./file-command"); +const utils_1 = require("./utils"); +const os = __importStar(require("os")); +const path = __importStar(require("path")); /** * The code to exit an action */ @@ -32,11 +41,21 @@ var ExitCode; /** * Sets env variable for this action and future actions in the job * @param name the name of the variable to set - * @param val the value of the variable + * @param val the value of the variable. Non-string values will be converted to a string via JSON.stringify */ +// eslint-disable-next-line @typescript-eslint/no-explicit-any function exportVariable(name, val) { - process.env[name] = val; - command_1.issueCommand('set-env', { name }, val); + const convertedVal = utils_1.toCommandValue(val); + process.env[name] = convertedVal; + const filePath = process.env['GITHUB_ENV'] || ''; + if (filePath) { + const delimiter = '_GitHubActionsFileCommandDelimeter_'; + const commandValue = `${name}<<${delimiter}${os.EOL}${convertedVal}${os.EOL}${delimiter}`; + file_command_1.issueCommand('ENV', commandValue); + } + else { + command_1.issueCommand('set-env', { name }, convertedVal); + } } exports.exportVariable = exportVariable; /** @@ -52,7 +71,13 @@ exports.setSecret = setSecret; * @param inputPath */ function addPath(inputPath) { - command_1.issueCommand('add-path', {}, inputPath); + const filePath = process.env['GITHUB_PATH'] || ''; + if (filePath) { + file_command_1.issueCommand('PATH', inputPath); + } + else { + command_1.issueCommand('add-path', {}, inputPath); + } process.env['PATH'] = `${inputPath}${path.delimiter}${process.env['PATH']}`; } exports.addPath = addPath; @@ -75,12 +100,22 @@ exports.getInput = getInput; * Sets the value of an output. * * @param name name of the output to set - * @param value value to store + * @param value value to store. Non-string values will be converted to a string via JSON.stringify */ +// eslint-disable-next-line @typescript-eslint/no-explicit-any function setOutput(name, value) { command_1.issueCommand('set-output', { name }, value); } exports.setOutput = setOutput; +/** + * Enables or disables the echoing of commands into stdout for the rest of the step. + * Echoing is disabled by default if ACTIONS_STEP_DEBUG is not set. + * + */ +function setCommandEcho(enabled) { + command_1.issue('echo', enabled ? 'on' : 'off'); +} +exports.setCommandEcho = setCommandEcho; //----------------------------------------------------------------------- // Results //----------------------------------------------------------------------- @@ -97,6 +132,13 @@ exports.setFailed = setFailed; //----------------------------------------------------------------------- // Logging Commands //----------------------------------------------------------------------- +/** + * Gets whether Actions Step Debug is on or not + */ +function isDebug() { + return process.env['RUNNER_DEBUG'] === '1'; +} +exports.isDebug = isDebug; /** * Writes debug message to user log * @param message debug message @@ -107,18 +149,18 @@ function debug(message) { exports.debug = debug; /** * Adds an error issue - * @param message error issue message + * @param message error issue message. Errors will be converted to string via toString() */ function error(message) { - command_1.issue('error', message); + command_1.issue('error', message instanceof Error ? message.toString() : message); } exports.error = error; /** * Adds an warning issue - * @param message warning issue message + * @param message warning issue message. Errors will be converted to string via toString() */ function warning(message) { - command_1.issue('warning', message); + command_1.issue('warning', message instanceof Error ? message.toString() : message); } exports.warning = warning; /** @@ -176,8 +218,9 @@ exports.group = group; * Saves state for current action, the state can only be retrieved by this action's post job execution. * * @param name name of the state to store - * @param value value to store + * @param value value to store. Non-string values will be converted to a string via JSON.stringify */ +// eslint-disable-next-line @typescript-eslint/no-explicit-any function saveState(name, value) { command_1.issueCommand('save-state', { name }, value); } diff --git a/node_modules/@actions/core/lib/core.js.map b/node_modules/@actions/core/lib/core.js.map index 6eda8da..7e7cbcc 100644 --- a/node_modules/@actions/core/lib/core.js.map +++ b/node_modules/@actions/core/lib/core.js.map @@ -1 +1 @@ -{"version":3,"file":"core.js","sourceRoot":"","sources":["../src/core.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,uCAA6C;AAE7C,yBAAwB;AACxB,6BAA4B;AAU5B;;GAEG;AACH,IAAY,QAUX;AAVD,WAAY,QAAQ;IAClB;;OAEG;IACH,6CAAW,CAAA;IAEX;;OAEG;IACH,6CAAW,CAAA;AACb,CAAC,EAVW,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QAUnB;AAED,yEAAyE;AACzE,YAAY;AACZ,yEAAyE;AAEzE;;;;GAIG;AACH,SAAgB,cAAc,CAAC,IAAY,EAAE,GAAW;IACtD,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,GAAG,CAAA;IACvB,sBAAY,CAAC,SAAS,EAAE,EAAC,IAAI,EAAC,EAAE,GAAG,CAAC,CAAA;AACtC,CAAC;AAHD,wCAGC;AAED;;;GAGG;AACH,SAAgB,SAAS,CAAC,MAAc;IACtC,sBAAY,CAAC,UAAU,EAAE,EAAE,EAAE,MAAM,CAAC,CAAA;AACtC,CAAC;AAFD,8BAEC;AAED;;;GAGG;AACH,SAAgB,OAAO,CAAC,SAAiB;IACvC,sBAAY,CAAC,UAAU,EAAE,EAAE,EAAE,SAAS,CAAC,CAAA;IACvC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,GAAG,SAAS,GAAG,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAA;AAC7E,CAAC;AAHD,0BAGC;AAED;;;;;;GAMG;AACH,SAAgB,QAAQ,CAAC,IAAY,EAAE,OAAsB;IAC3D,MAAM,GAAG,GACP,OAAO,CAAC,GAAG,CAAC,SAAS,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,IAAI,EAAE,CAAA;IACrE,IAAI,OAAO,IAAI,OAAO,CAAC,QAAQ,IAAI,CAAC,GAAG,EAAE;QACvC,MAAM,IAAI,KAAK,CAAC,oCAAoC,IAAI,EAAE,CAAC,CAAA;KAC5D;IAED,OAAO,GAAG,CAAC,IAAI,EAAE,CAAA;AACnB,CAAC;AARD,4BAQC;AAED;;;;;GAKG;AACH,SAAgB,SAAS,CAAC,IAAY,EAAE,KAAa;IACnD,sBAAY,CAAC,YAAY,EAAE,EAAC,IAAI,EAAC,EAAE,KAAK,CAAC,CAAA;AAC3C,CAAC;AAFD,8BAEC;AAED,yEAAyE;AACzE,UAAU;AACV,yEAAyE;AAEzE;;;;GAIG;AACH,SAAgB,SAAS,CAAC,OAAe;IACvC,OAAO,CAAC,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAA;IACnC,KAAK,CAAC,OAAO,CAAC,CAAA;AAChB,CAAC;AAHD,8BAGC;AAED,yEAAyE;AACzE,mBAAmB;AACnB,yEAAyE;AAEzE;;;GAGG;AACH,SAAgB,KAAK,CAAC,OAAe;IACnC,sBAAY,CAAC,OAAO,EAAE,EAAE,EAAE,OAAO,CAAC,CAAA;AACpC,CAAC;AAFD,sBAEC;AAED;;;GAGG;AACH,SAAgB,KAAK,CAAC,OAAe;IACnC,eAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;AACzB,CAAC;AAFD,sBAEC;AAED;;;GAGG;AACH,SAAgB,OAAO,CAAC,OAAe;IACrC,eAAK,CAAC,SAAS,EAAE,OAAO,CAAC,CAAA;AAC3B,CAAC;AAFD,0BAEC;AAED;;;GAGG;AACH,SAAgB,IAAI,CAAC,OAAe;IAClC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,GAAG,EAAE,CAAC,GAAG,CAAC,CAAA;AACxC,CAAC;AAFD,oBAEC;AAED;;;;;;GAMG;AACH,SAAgB,UAAU,CAAC,IAAY;IACrC,eAAK,CAAC,OAAO,EAAE,IAAI,CAAC,CAAA;AACtB,CAAC;AAFD,gCAEC;AAED;;GAEG;AACH,SAAgB,QAAQ;IACtB,eAAK,CAAC,UAAU,CAAC,CAAA;AACnB,CAAC;AAFD,4BAEC;AAED;;;;;;;GAOG;AACH,SAAsB,KAAK,CAAI,IAAY,EAAE,EAAoB;;QAC/D,UAAU,CAAC,IAAI,CAAC,CAAA;QAEhB,IAAI,MAAS,CAAA;QAEb,IAAI;YACF,MAAM,GAAG,MAAM,EAAE,EAAE,CAAA;SACpB;gBAAS;YACR,QAAQ,EAAE,CAAA;SACX;QAED,OAAO,MAAM,CAAA;IACf,CAAC;CAAA;AAZD,sBAYC;AAED,yEAAyE;AACzE,uBAAuB;AACvB,yEAAyE;AAEzE;;;;;GAKG;AACH,SAAgB,SAAS,CAAC,IAAY,EAAE,KAAa;IACnD,sBAAY,CAAC,YAAY,EAAE,EAAC,IAAI,EAAC,EAAE,KAAK,CAAC,CAAA;AAC3C,CAAC;AAFD,8BAEC;AAED;;;;;GAKG;AACH,SAAgB,QAAQ,CAAC,IAAY;IACnC,OAAO,OAAO,CAAC,GAAG,CAAC,SAAS,IAAI,EAAE,CAAC,IAAI,EAAE,CAAA;AAC3C,CAAC;AAFD,4BAEC"} \ No newline at end of file +{"version":3,"file":"core.js","sourceRoot":"","sources":["../src/core.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AAAA,uCAA6C;AAC7C,iDAA+D;AAC/D,mCAAsC;AAEtC,uCAAwB;AACxB,2CAA4B;AAU5B;;GAEG;AACH,IAAY,QAUX;AAVD,WAAY,QAAQ;IAClB;;OAEG;IACH,6CAAW,CAAA;IAEX;;OAEG;IACH,6CAAW,CAAA;AACb,CAAC,EAVW,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QAUnB;AAED,yEAAyE;AACzE,YAAY;AACZ,yEAAyE;AAEzE;;;;GAIG;AACH,8DAA8D;AAC9D,SAAgB,cAAc,CAAC,IAAY,EAAE,GAAQ;IACnD,MAAM,YAAY,GAAG,sBAAc,CAAC,GAAG,CAAC,CAAA;IACxC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,YAAY,CAAA;IAEhC,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,EAAE,CAAA;IAChD,IAAI,QAAQ,EAAE;QACZ,MAAM,SAAS,GAAG,qCAAqC,CAAA;QACvD,MAAM,YAAY,GAAG,GAAG,IAAI,KAAK,SAAS,GAAG,EAAE,CAAC,GAAG,GAAG,YAAY,GAAG,EAAE,CAAC,GAAG,GAAG,SAAS,EAAE,CAAA;QACzF,2BAAgB,CAAC,KAAK,EAAE,YAAY,CAAC,CAAA;KACtC;SAAM;QACL,sBAAY,CAAC,SAAS,EAAE,EAAC,IAAI,EAAC,EAAE,YAAY,CAAC,CAAA;KAC9C;AACH,CAAC;AAZD,wCAYC;AAED;;;GAGG;AACH,SAAgB,SAAS,CAAC,MAAc;IACtC,sBAAY,CAAC,UAAU,EAAE,EAAE,EAAE,MAAM,CAAC,CAAA;AACtC,CAAC;AAFD,8BAEC;AAED;;;GAGG;AACH,SAAgB,OAAO,CAAC,SAAiB;IACvC,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,IAAI,EAAE,CAAA;IACjD,IAAI,QAAQ,EAAE;QACZ,2BAAgB,CAAC,MAAM,EAAE,SAAS,CAAC,CAAA;KACpC;SAAM;QACL,sBAAY,CAAC,UAAU,EAAE,EAAE,EAAE,SAAS,CAAC,CAAA;KACxC;IACD,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,GAAG,SAAS,GAAG,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAA;AAC7E,CAAC;AARD,0BAQC;AAED;;;;;;GAMG;AACH,SAAgB,QAAQ,CAAC,IAAY,EAAE,OAAsB;IAC3D,MAAM,GAAG,GACP,OAAO,CAAC,GAAG,CAAC,SAAS,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,IAAI,EAAE,CAAA;IACrE,IAAI,OAAO,IAAI,OAAO,CAAC,QAAQ,IAAI,CAAC,GAAG,EAAE;QACvC,MAAM,IAAI,KAAK,CAAC,oCAAoC,IAAI,EAAE,CAAC,CAAA;KAC5D;IAED,OAAO,GAAG,CAAC,IAAI,EAAE,CAAA;AACnB,CAAC;AARD,4BAQC;AAED;;;;;GAKG;AACH,8DAA8D;AAC9D,SAAgB,SAAS,CAAC,IAAY,EAAE,KAAU;IAChD,sBAAY,CAAC,YAAY,EAAE,EAAC,IAAI,EAAC,EAAE,KAAK,CAAC,CAAA;AAC3C,CAAC;AAFD,8BAEC;AAED;;;;GAIG;AACH,SAAgB,cAAc,CAAC,OAAgB;IAC7C,eAAK,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAA;AACvC,CAAC;AAFD,wCAEC;AAED,yEAAyE;AACzE,UAAU;AACV,yEAAyE;AAEzE;;;;GAIG;AACH,SAAgB,SAAS,CAAC,OAAuB;IAC/C,OAAO,CAAC,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAA;IAEnC,KAAK,CAAC,OAAO,CAAC,CAAA;AAChB,CAAC;AAJD,8BAIC;AAED,yEAAyE;AACzE,mBAAmB;AACnB,yEAAyE;AAEzE;;GAEG;AACH,SAAgB,OAAO;IACrB,OAAO,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,KAAK,GAAG,CAAA;AAC5C,CAAC;AAFD,0BAEC;AAED;;;GAGG;AACH,SAAgB,KAAK,CAAC,OAAe;IACnC,sBAAY,CAAC,OAAO,EAAE,EAAE,EAAE,OAAO,CAAC,CAAA;AACpC,CAAC;AAFD,sBAEC;AAED;;;GAGG;AACH,SAAgB,KAAK,CAAC,OAAuB;IAC3C,eAAK,CAAC,OAAO,EAAE,OAAO,YAAY,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAA;AACzE,CAAC;AAFD,sBAEC;AAED;;;GAGG;AACH,SAAgB,OAAO,CAAC,OAAuB;IAC7C,eAAK,CAAC,SAAS,EAAE,OAAO,YAAY,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAA;AAC3E,CAAC;AAFD,0BAEC;AAED;;;GAGG;AACH,SAAgB,IAAI,CAAC,OAAe;IAClC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,GAAG,EAAE,CAAC,GAAG,CAAC,CAAA;AACxC,CAAC;AAFD,oBAEC;AAED;;;;;;GAMG;AACH,SAAgB,UAAU,CAAC,IAAY;IACrC,eAAK,CAAC,OAAO,EAAE,IAAI,CAAC,CAAA;AACtB,CAAC;AAFD,gCAEC;AAED;;GAEG;AACH,SAAgB,QAAQ;IACtB,eAAK,CAAC,UAAU,CAAC,CAAA;AACnB,CAAC;AAFD,4BAEC;AAED;;;;;;;GAOG;AACH,SAAsB,KAAK,CAAI,IAAY,EAAE,EAAoB;;QAC/D,UAAU,CAAC,IAAI,CAAC,CAAA;QAEhB,IAAI,MAAS,CAAA;QAEb,IAAI;YACF,MAAM,GAAG,MAAM,EAAE,EAAE,CAAA;SACpB;gBAAS;YACR,QAAQ,EAAE,CAAA;SACX;QAED,OAAO,MAAM,CAAA;IACf,CAAC;CAAA;AAZD,sBAYC;AAED,yEAAyE;AACzE,uBAAuB;AACvB,yEAAyE;AAEzE;;;;;GAKG;AACH,8DAA8D;AAC9D,SAAgB,SAAS,CAAC,IAAY,EAAE,KAAU;IAChD,sBAAY,CAAC,YAAY,EAAE,EAAC,IAAI,EAAC,EAAE,KAAK,CAAC,CAAA;AAC3C,CAAC;AAFD,8BAEC;AAED;;;;;GAKG;AACH,SAAgB,QAAQ,CAAC,IAAY;IACnC,OAAO,OAAO,CAAC,GAAG,CAAC,SAAS,IAAI,EAAE,CAAC,IAAI,EAAE,CAAA;AAC3C,CAAC;AAFD,4BAEC"} \ No newline at end of file diff --git a/node_modules/@actions/core/package.json b/node_modules/@actions/core/package.json index b11b97c..19e6466 100644 --- a/node_modules/@actions/core/package.json +++ b/node_modules/@actions/core/package.json @@ -1,34 +1,36 @@ { - "_from": "@actions/core@1.2.0", - "_id": "@actions/core@1.2.0", + "_args": [ + [ + "@actions/core@1.2.6", + "/Users/marocchino/Documents/sticky-pull-request-comment" + ] + ], + "_from": "@actions/core@1.2.6", + "_id": "@actions/core@1.2.6", "_inBundle": false, - "_integrity": "sha512-ZKdyhlSlyz38S6YFfPnyNgCDZuAF2T0Qv5eHflNWytPS8Qjvz39bZFMry9Bb/dpSnqWcNeav5yM2CTYpJeY+Dw==", + "_integrity": "sha512-ZQYitnqiyBc3D+k7LsgSBmMDVkOVidaagDG7j3fOym77jNunWRuYx7VSHa9GNfFZh+zh61xsCjRj4JxMZlDqTA==", "_location": "/@actions/core", "_phantomChildren": {}, "_requested": { "type": "version", "registry": true, - "raw": "@actions/core@1.2.0", + "raw": "@actions/core@1.2.6", "name": "@actions/core", "escapedName": "@actions%2fcore", "scope": "@actions", - "rawSpec": "1.2.0", + "rawSpec": "1.2.6", "saveSpec": null, - "fetchSpec": "1.2.0" + "fetchSpec": "1.2.6" }, "_requiredBy": [ - "#USER", "/" ], - "_resolved": "https://registry.npmjs.org/@actions/core/-/core-1.2.0.tgz", - "_shasum": "aa5f52b26c362c821d41557e599371a42f6c0b3d", - "_spec": "@actions/core@1.2.0", - "_where": "/Users/shim.taewon/Documents/sticky-pull-request-comment", + "_resolved": "https://registry.npmjs.org/@actions/core/-/core-1.2.6.tgz", + "_spec": "1.2.6", + "_where": "/Users/marocchino/Documents/sticky-pull-request-comment", "bugs": { "url": "https://github.com/actions/toolkit/issues" }, - "bundleDependencies": false, - "deprecated": false, "description": "Actions core lib", "devDependencies": { "@types/node": "^12.0.2" @@ -38,9 +40,10 @@ "test": "__tests__" }, "files": [ - "lib" + "lib", + "!.DS_Store" ], - "homepage": "https://github.com/actions/toolkit/tree/master/packages/core", + "homepage": "https://github.com/actions/toolkit/tree/main/packages/core", "keywords": [ "github", "actions", @@ -58,8 +61,10 @@ "directory": "packages/core" }, "scripts": { + "audit-moderate": "npm install && npm audit --json --audit-level=moderate > audit.json", "test": "echo \"Error: run tests from root\" && exit 1", "tsc": "tsc" }, - "version": "1.2.0" + "types": "lib/core.d.ts", + "version": "1.2.6" } diff --git a/node_modules/@actions/github/LICENSE.md b/node_modules/@actions/github/LICENSE.md deleted file mode 100644 index e5a73f4..0000000 --- a/node_modules/@actions/github/LICENSE.md +++ /dev/null @@ -1,7 +0,0 @@ -Copyright 2019 GitHub - -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. \ No newline at end of file diff --git a/node_modules/@actions/github/README.md b/node_modules/@actions/github/README.md index b431256..ce606c1 100644 --- a/node_modules/@actions/github/README.md +++ b/node_modules/@actions/github/README.md @@ -4,30 +4,37 @@ ## Usage -Returns an Octokit client. See https://octokit.github.io/rest.js for the API. +Returns an authenticated Octokit client that follows the machine [proxy settings](https://help.github.com/en/actions/hosting-your-own-runners/using-a-proxy-server-with-self-hosted-runners). See https://octokit.github.io/rest.js for the API. ```js const github = require('@actions/github'); const core = require('@actions/core'); -// This should be a token with access to your repository scoped in as a secret. -const myToken = core.getInput('myToken'); +async function run() { + // This should be a token with access to your repository scoped in as a secret. + // The YML workflow will need to set myToken with the GitHub Secret Token + // myToken: ${{ secrets.GITHUB_TOKEN }} + // https://help.github.com/en/actions/automating-your-workflow-with-github-actions/authenticating-with-the-github_token#about-the-github_token-secret + const myToken = core.getInput('myToken'); -const octokit = new github.GitHub(myToken); + const octokit = new github.GitHub(myToken); -const { data: pullRequest } = await octokit.pulls.get({ - owner: 'octokit', - repo: 'rest.js', - pull_number: 123, - mediaType: { - format: 'diff' - } -}); + const { data: pullRequest } = await octokit.pulls.get({ + owner: 'octokit', + repo: 'rest.js', + pull_number: 123, + mediaType: { + format: 'diff' + } + }); -console.log(pullRequest); + console.log(pullRequest); +} + +run(); ``` -You can pass client options (except `auth`, which is handled by the token argument), as specified by [Octokit](https://octokit.github.io/rest.js/), as a second argument to the `GitHub` constructor. +You can pass client options, as specified by [Octokit](https://octokit.github.io/rest.js/), as a second argument to the `GitHub` constructor. You can also make GraphQL requests. See https://github.com/octokit/graphql.js for the API. @@ -48,3 +55,20 @@ const newIssue = await octokit.issues.create({ body: 'Hello Universe!' }); ``` + +## 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. + +First, install the npm module `npm install @octokit/webhooks` + +Then, assert the type based on the eventName +```ts +import * as core from '@actions/core' +import * as github from '@actions/github' +import * as Webhooks from '@octokit/webhooks' +if (github.context.eventName === 'push') { + const pushPayload = github.context.payload as Webhooks.WebhookPayloadPush + core.info(`The head commit is: ${pushPayload.head}`) +} +``` diff --git a/node_modules/@actions/github/lib/context.d.ts b/node_modules/@actions/github/lib/context.d.ts index 3ee7583..434fdb1 100644 --- a/node_modules/@actions/github/lib/context.d.ts +++ b/node_modules/@actions/github/lib/context.d.ts @@ -14,12 +14,12 @@ export declare class Context { * Hydrate the context from the environment */ constructor(); - readonly issue: { + get issue(): { owner: string; repo: string; number: number; }; - readonly repo: { + get repo(): { owner: string; repo: string; }; diff --git a/node_modules/@actions/github/lib/context.js b/node_modules/@actions/github/lib/context.js index 0df128f..25ceea5 100644 --- a/node_modules/@actions/github/lib/context.js +++ b/node_modules/@actions/github/lib/context.js @@ -13,7 +13,8 @@ class Context { this.payload = JSON.parse(fs_1.readFileSync(process.env.GITHUB_EVENT_PATH, { encoding: 'utf8' })); } else { - process.stdout.write(`GITHUB_EVENT_PATH ${process.env.GITHUB_EVENT_PATH} does not exist${os_1.EOL}`); + const path = process.env.GITHUB_EVENT_PATH; + process.stdout.write(`GITHUB_EVENT_PATH ${path} does not exist${os_1.EOL}`); } } this.eventName = process.env.GITHUB_EVENT_NAME; @@ -25,7 +26,7 @@ class Context { } get issue() { const payload = this.payload; - return Object.assign(Object.assign({}, this.repo), { number: (payload.issue || payload.pullRequest || payload).number }); + return Object.assign(Object.assign({}, this.repo), { number: (payload.issue || payload.pull_request || payload).number }); } get repo() { if (process.env.GITHUB_REPOSITORY) { diff --git a/node_modules/@actions/github/lib/context.js.map b/node_modules/@actions/github/lib/context.js.map index 24eabd8..d05ca0d 100644 --- a/node_modules/@actions/github/lib/context.js.map +++ b/node_modules/@actions/github/lib/context.js.map @@ -1 +1 @@ -{"version":3,"file":"context.js","sourceRoot":"","sources":["../src/context.ts"],"names":[],"mappings":";;AAEA,2BAA2C;AAC3C,2BAAsB;AAEtB,MAAa,OAAO;IAalB;;OAEG;IACH;QACE,IAAI,CAAC,OAAO,GAAG,EAAE,CAAA;QACjB,IAAI,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE;YACjC,IAAI,eAAU,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,EAAE;gBAC7C,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,KAAK,CACvB,iBAAY,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE,EAAC,QAAQ,EAAE,MAAM,EAAC,CAAC,CAChE,CAAA;aACF;iBAAM;gBACL,OAAO,CAAC,MAAM,CAAC,KAAK,CAClB,qBACE,OAAO,CAAC,GAAG,CAAC,iBACd,kBAAkB,QAAG,EAAE,CACxB,CAAA;aACF;SACF;QACD,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC,iBAA2B,CAAA;QACxD,IAAI,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,UAAoB,CAAA;QAC3C,IAAI,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,UAAoB,CAAA;QAC3C,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,eAAyB,CAAA;QACrD,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,aAAuB,CAAA;QACjD,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,YAAsB,CAAA;IACjD,CAAC;IAED,IAAI,KAAK;QACP,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAA;QAE5B,uCACK,IAAI,CAAC,IAAI,KACZ,MAAM,EAAE,CAAC,OAAO,CAAC,KAAK,IAAI,OAAO,CAAC,WAAW,IAAI,OAAO,CAAC,CAAC,MAAM,IACjE;IACH,CAAC;IAED,IAAI,IAAI;QACN,IAAI,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE;YACjC,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;YAC9D,OAAO,EAAC,KAAK,EAAE,IAAI,EAAC,CAAA;SACrB;QAED,IAAI,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE;YAC3B,OAAO;gBACL,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,KAAK;gBAC1C,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI;aACnC,CAAA;SACF;QAED,MAAM,IAAI,KAAK,CACb,kFAAkF,CACnF,CAAA;IACH,CAAC;CACF;AAjED,0BAiEC"} \ No newline at end of file +{"version":3,"file":"context.js","sourceRoot":"","sources":["../src/context.ts"],"names":[],"mappings":";;AAEA,2BAA2C;AAC3C,2BAAsB;AAEtB,MAAa,OAAO;IAalB;;OAEG;IACH;QACE,IAAI,CAAC,OAAO,GAAG,EAAE,CAAA;QACjB,IAAI,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE;YACjC,IAAI,eAAU,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,EAAE;gBAC7C,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,KAAK,CACvB,iBAAY,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE,EAAC,QAAQ,EAAE,MAAM,EAAC,CAAC,CAChE,CAAA;aACF;iBAAM;gBACL,MAAM,IAAI,GAAG,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAA;gBAC1C,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,qBAAqB,IAAI,kBAAkB,QAAG,EAAE,CAAC,CAAA;aACvE;SACF;QACD,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC,iBAA2B,CAAA;QACxD,IAAI,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,UAAoB,CAAA;QAC3C,IAAI,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,UAAoB,CAAA;QAC3C,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,eAAyB,CAAA;QACrD,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,aAAuB,CAAA;QACjD,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,YAAsB,CAAA;IACjD,CAAC;IAED,IAAI,KAAK;QACP,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAA;QAE5B,uCACK,IAAI,CAAC,IAAI,KACZ,MAAM,EAAE,CAAC,OAAO,CAAC,KAAK,IAAI,OAAO,CAAC,YAAY,IAAI,OAAO,CAAC,CAAC,MAAM,IAClE;IACH,CAAC;IAED,IAAI,IAAI;QACN,IAAI,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE;YACjC,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;YAC9D,OAAO,EAAC,KAAK,EAAE,IAAI,EAAC,CAAA;SACrB;QAED,IAAI,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE;YAC3B,OAAO;gBACL,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,KAAK;gBAC1C,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI;aACnC,CAAA;SACF;QAED,MAAM,IAAI,KAAK,CACb,kFAAkF,CACnF,CAAA;IACH,CAAC;CACF;AA9DD,0BA8DC"} \ No newline at end of file diff --git a/node_modules/@actions/github/lib/github.d.ts b/node_modules/@actions/github/lib/github.d.ts index 7c5b9f2..a80e266 100644 --- a/node_modules/@actions/github/lib/github.d.ts +++ b/node_modules/@actions/github/lib/github.d.ts @@ -1,8 +1,27 @@ -import { GraphQlQueryResponse, Variables } from '@octokit/graphql'; -import Octokit from '@octokit/rest'; +import { graphql as GraphQL } from '@octokit/graphql/dist-types/types'; +import { Octokit } from '@octokit/rest'; import * as Context from './context'; export declare const context: Context.Context; export declare class GitHub extends Octokit { - graphql: (query: string, variables?: Variables) => Promise; + graphql: GraphQL; + /** + * Sets up the REST client and GraphQL client with auth and proxy support. + * The parameter `token` or `opts.auth` must be supplied. The GraphQL client + * authorization is not setup when `opts.auth` is a function or object. + * + * @param token Auth token + * @param opts Octokit options + */ constructor(token: string, opts?: Omit); + constructor(opts: Octokit.Options); + /** + * Disambiguates the constructor overload parameters + */ + private static disambiguate; + private static getOctokitOptions; + private static getGraphQL; + private static getAuthString; + private static getProxyAgent; + private static getApiBaseUrl; + private static getGraphQLBaseUrl; } diff --git a/node_modules/@actions/github/lib/github.js b/node_modules/@actions/github/lib/github.js index d5c782f..c2055d8 100644 --- a/node_modules/@actions/github/lib/github.js +++ b/node_modules/@actions/github/lib/github.js @@ -1,7 +1,4 @@ "use strict"; -var __importDefault = (this && this.__importDefault) || function (mod) { - return (mod && mod.__esModule) ? mod : { "default": mod }; -}; var __importStar = (this && this.__importStar) || function (mod) { if (mod && mod.__esModule) return mod; var result = {}; @@ -12,17 +9,99 @@ var __importStar = (this && this.__importStar) || function (mod) { Object.defineProperty(exports, "__esModule", { value: true }); // Originally pulled from https://github.com/JasonEtco/actions-toolkit/blob/master/src/github.ts const graphql_1 = require("@octokit/graphql"); -const rest_1 = __importDefault(require("@octokit/rest")); +const rest_1 = require("@octokit/rest"); const Context = __importStar(require("./context")); +const httpClient = __importStar(require("@actions/http-client")); // We need this in order to extend Octokit -rest_1.default.prototype = new rest_1.default(); +rest_1.Octokit.prototype = new rest_1.Octokit(); exports.context = new Context.Context(); -class GitHub extends rest_1.default { - constructor(token, opts = {}) { - super(Object.assign(Object.assign({}, opts), { auth: `token ${token}` })); - this.graphql = graphql_1.defaults({ - headers: { authorization: `token ${token}` } - }); +class GitHub extends rest_1.Octokit { + constructor(token, opts) { + super(GitHub.getOctokitOptions(GitHub.disambiguate(token, opts))); + this.graphql = GitHub.getGraphQL(GitHub.disambiguate(token, opts)); + } + /** + * Disambiguates the constructor overload parameters + */ + static disambiguate(token, opts) { + return [ + typeof token === 'string' ? token : '', + typeof token === 'object' ? token : opts || {} + ]; + } + static getOctokitOptions(args) { + const token = args[0]; + const options = Object.assign({}, args[1]); // Shallow clone - don't mutate the object provided by the caller + // Base URL - GHES or Dotcom + options.baseUrl = options.baseUrl || this.getApiBaseUrl(); + // Auth + const auth = GitHub.getAuthString(token, options); + if (auth) { + options.auth = auth; + } + // Proxy + const agent = GitHub.getProxyAgent(options.baseUrl, options); + if (agent) { + // Shallow clone - don't mutate the object provided by the caller + options.request = options.request ? Object.assign({}, options.request) : {}; + // Set the agent + options.request.agent = agent; + } + return options; + } + static getGraphQL(args) { + const defaults = {}; + defaults.baseUrl = this.getGraphQLBaseUrl(); + const token = args[0]; + const options = args[1]; + // Authorization + const auth = this.getAuthString(token, options); + if (auth) { + defaults.headers = { + authorization: auth + }; + } + // Proxy + const agent = GitHub.getProxyAgent(defaults.baseUrl, options); + if (agent) { + defaults.request = { agent }; + } + return graphql_1.graphql.defaults(defaults); + } + static getAuthString(token, options) { + // Validate args + if (!token && !options.auth) { + throw new Error('Parameter token or opts.auth is required'); + } + else if (token && options.auth) { + throw new Error('Parameters token and opts.auth may not both be specified'); + } + return typeof options.auth === 'string' ? options.auth : `token ${token}`; + } + static getProxyAgent(destinationUrl, options) { + var _a; + if (!((_a = options.request) === null || _a === void 0 ? void 0 : _a.agent)) { + if (httpClient.getProxyUrl(destinationUrl)) { + const hc = new httpClient.HttpClient(); + return hc.getAgent(destinationUrl); + } + } + return undefined; + } + static getApiBaseUrl() { + return process.env['GITHUB_API_URL'] || 'https://api.github.com'; + } + static getGraphQLBaseUrl() { + let url = process.env['GITHUB_GRAPHQL_URL'] || 'https://api.github.com/graphql'; + // Shouldn't be a trailing slash, but remove if so + if (url.endsWith('/')) { + url = url.substr(0, url.length - 1); + } + // Remove trailing "/graphql" + if (url.toUpperCase().endsWith('/GRAPHQL')) { + url = url.substr(0, url.length - '/graphql'.length); + } + return url; } } exports.GitHub = GitHub; diff --git a/node_modules/@actions/github/lib/github.js.map b/node_modules/@actions/github/lib/github.js.map index 0c268e8..e5e5a86 100644 --- a/node_modules/@actions/github/lib/github.js.map +++ b/node_modules/@actions/github/lib/github.js.map @@ -1 +1 @@ -{"version":3,"file":"github.js","sourceRoot":"","sources":["../src/github.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,gGAAgG;AAChG,8CAA0E;AAC1E,yDAAmC;AACnC,mDAAoC;AAEpC,0CAA0C;AAC1C,cAAO,CAAC,SAAS,GAAG,IAAI,cAAO,EAAE,CAAA;AAEpB,QAAA,OAAO,GAAG,IAAI,OAAO,CAAC,OAAO,EAAE,CAAA;AAE5C,MAAa,MAAO,SAAQ,cAAO;IAMjC,YAAY,KAAa,EAAE,OAAsC,EAAE;QACjE,KAAK,iCAAK,IAAI,KAAE,IAAI,EAAE,SAAS,KAAK,EAAE,IAAE,CAAA;QACxC,IAAI,CAAC,OAAO,GAAG,kBAAQ,CAAC;YACtB,OAAO,EAAE,EAAC,aAAa,EAAE,SAAS,KAAK,EAAE,EAAC;SAC3C,CAAC,CAAA;IACJ,CAAC;CACF;AAZD,wBAYC"} \ No newline at end of file +{"version":3,"file":"github.js","sourceRoot":"","sources":["../src/github.ts"],"names":[],"mappings":";;;;;;;;;AAAA,gGAAgG;AAChG,8CAAwC;AAUxC,wCAAqC;AACrC,mDAAoC;AAEpC,iEAAkD;AAElD,0CAA0C;AAC1C,cAAO,CAAC,SAAS,GAAG,IAAI,cAAO,EAAE,CAAA;AAEpB,QAAA,OAAO,GAAG,IAAI,OAAO,CAAC,OAAO,EAAE,CAAA;AAE5C,MAAa,MAAO,SAAQ,cAAO;IAiBjC,YAAY,KAA+B,EAAE,IAAsB;QACjE,KAAK,CAAC,MAAM,CAAC,iBAAiB,CAAC,MAAM,CAAC,YAAY,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC,CAAA;QAEjE,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,YAAY,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAA;IACpE,CAAC;IAED;;OAEG;IACK,MAAM,CAAC,YAAY,CACzB,KAA+B,EAC/B,IAAsB;QAEtB,OAAO;YACL,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE;YACtC,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE;SAC/C,CAAA;IACH,CAAC;IAEO,MAAM,CAAC,iBAAiB,CAC9B,IAA+B;QAE/B,MAAM,KAAK,GAAG,IAAI,CAAC,CAAC,CAAC,CAAA;QACrB,MAAM,OAAO,qBAAO,IAAI,CAAC,CAAC,CAAC,CAAC,CAAA,CAAC,iEAAiE;QAE9F,4BAA4B;QAC5B,OAAO,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,IAAI,CAAC,aAAa,EAAE,CAAA;QAEzD,OAAO;QACP,MAAM,IAAI,GAAG,MAAM,CAAC,aAAa,CAAC,KAAK,EAAE,OAAO,CAAC,CAAA;QACjD,IAAI,IAAI,EAAE;YACR,OAAO,CAAC,IAAI,GAAG,IAAI,CAAA;SACpB;QAED,QAAQ;QACR,MAAM,KAAK,GAAG,MAAM,CAAC,aAAa,CAAC,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;QAC5D,IAAI,KAAK,EAAE;YACT,iEAAiE;YACjE,OAAO,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,mBAAK,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,EAAE,CAAA;YAE7D,gBAAgB;YAChB,OAAO,CAAC,OAAO,CAAC,KAAK,GAAG,KAAK,CAAA;SAC9B;QAED,OAAO,OAAO,CAAA;IAChB,CAAC;IAEO,MAAM,CAAC,UAAU,CAAC,IAA+B;QACvD,MAAM,QAAQ,GAA6B,EAAE,CAAA;QAC7C,QAAQ,CAAC,OAAO,GAAG,IAAI,CAAC,iBAAiB,EAAE,CAAA;QAC3C,MAAM,KAAK,GAAG,IAAI,CAAC,CAAC,CAAC,CAAA;QACrB,MAAM,OAAO,GAAG,IAAI,CAAC,CAAC,CAAC,CAAA;QAEvB,gBAAgB;QAChB,MAAM,IAAI,GAAG,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE,OAAO,CAAC,CAAA;QAC/C,IAAI,IAAI,EAAE;YACR,QAAQ,CAAC,OAAO,GAAG;gBACjB,aAAa,EAAE,IAAI;aACpB,CAAA;SACF;QAED,QAAQ;QACR,MAAM,KAAK,GAAG,MAAM,CAAC,aAAa,CAAC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;QAC7D,IAAI,KAAK,EAAE;YACT,QAAQ,CAAC,OAAO,GAAG,EAAC,KAAK,EAAC,CAAA;SAC3B;QAED,OAAO,iBAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAA;IACnC,CAAC;IAEO,MAAM,CAAC,aAAa,CAC1B,KAAa,EACb,OAAwB;QAExB,gBAAgB;QAChB,IAAI,CAAC,KAAK,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE;YAC3B,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAA;SAC5D;aAAM,IAAI,KAAK,IAAI,OAAO,CAAC,IAAI,EAAE;YAChC,MAAM,IAAI,KAAK,CACb,0DAA0D,CAC3D,CAAA;SACF;QAED,OAAO,OAAO,OAAO,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,KAAK,EAAE,CAAA;IAC3E,CAAC;IAEO,MAAM,CAAC,aAAa,CAC1B,cAAsB,EACtB,OAAwB;;QAExB,IAAI,QAAC,OAAO,CAAC,OAAO,0CAAE,KAAK,CAAA,EAAE;YAC3B,IAAI,UAAU,CAAC,WAAW,CAAC,cAAc,CAAC,EAAE;gBAC1C,MAAM,EAAE,GAAG,IAAI,UAAU,CAAC,UAAU,EAAE,CAAA;gBACtC,OAAO,EAAE,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAA;aACnC;SACF;QAED,OAAO,SAAS,CAAA;IAClB,CAAC;IAEO,MAAM,CAAC,aAAa;QAC1B,OAAO,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC,IAAI,wBAAwB,CAAA;IAClE,CAAC;IAEO,MAAM,CAAC,iBAAiB;QAC9B,IAAI,GAAG,GACL,OAAO,CAAC,GAAG,CAAC,oBAAoB,CAAC,IAAI,gCAAgC,CAAA;QAEvE,kDAAkD;QAClD,IAAI,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;YACrB,GAAG,GAAG,GAAG,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;SACpC;QAED,6BAA6B;QAC7B,IAAI,GAAG,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE;YAC1C,GAAG,GAAG,GAAG,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,CAAC,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC,CAAA;SACpD;QACD,OAAO,GAAG,CAAA;IACZ,CAAC;CACF;AAxID,wBAwIC"} \ No newline at end of file diff --git a/node_modules/@actions/github/package.json b/node_modules/@actions/github/package.json index 733a1e3..e448739 100644 --- a/node_modules/@actions/github/package.json +++ b/node_modules/@actions/github/package.json @@ -1,41 +1,45 @@ { - "_from": "@actions/github@1.1.0", - "_id": "@actions/github@1.1.0", + "_args": [ + [ + "@actions/github@2.2.0", + "/Users/marocchino/Documents/sticky-pull-request-comment" + ] + ], + "_from": "@actions/github@2.2.0", + "_id": "@actions/github@2.2.0", "_inBundle": false, - "_integrity": "sha512-cHf6PyoNMdei13jEdGPhKprIMFmjVVW/dnM5/9QmQDJ1ZTaGVyezUSCUIC/ySNLRvDUpeFwPYMdThSEJldSbUw==", + "_integrity": "sha512-9UAZqn8ywdR70n3GwVle4N8ALosQs4z50N7XMXrSTUVOmVpaBC5kE3TRTT7qQdi3OaQV24mjGuJZsHUmhD+ZXw==", "_location": "/@actions/github", "_phantomChildren": {}, "_requested": { "type": "version", "registry": true, - "raw": "@actions/github@1.1.0", + "raw": "@actions/github@2.2.0", "name": "@actions/github", "escapedName": "@actions%2fgithub", "scope": "@actions", - "rawSpec": "1.1.0", + "rawSpec": "2.2.0", "saveSpec": null, - "fetchSpec": "1.1.0" + "fetchSpec": "2.2.0" }, "_requiredBy": [ - "#USER", "/" ], - "_resolved": "https://registry.npmjs.org/@actions/github/-/github-1.1.0.tgz", - "_shasum": "06f34e6b0cf07eb2b3641de3e680dbfae6bcd400", - "_spec": "@actions/github@1.1.0", - "_where": "/Users/shim.taewon/Documents/sticky-pull-request-comment", + "_resolved": "https://registry.npmjs.org/@actions/github/-/github-2.2.0.tgz", + "_spec": "2.2.0", + "_where": "/Users/marocchino/Documents/sticky-pull-request-comment", "bugs": { "url": "https://github.com/actions/toolkit/issues" }, - "bundleDependencies": false, "dependencies": { - "@octokit/graphql": "^2.0.1", - "@octokit/rest": "^16.15.0" + "@actions/http-client": "^1.0.3", + "@octokit/graphql": "^4.3.1", + "@octokit/rest": "^16.43.1" }, - "deprecated": false, "description": "Actions github lib", "devDependencies": { - "jest": "^24.7.1" + "jest": "^25.1.0", + "proxy": "^1.0.1" }, "directories": { "lib": "lib", @@ -44,7 +48,6 @@ "files": [ "lib" ], - "gitHead": "a2ab4bcf78e4f7080f0d45856e6eeba16f0bbc52", "homepage": "https://github.com/actions/toolkit/tree/master/packages/github", "keywords": [ "github", @@ -58,12 +61,17 @@ }, "repository": { "type": "git", - "url": "git+https://github.com/actions/toolkit.git" + "url": "git+https://github.com/actions/toolkit.git", + "directory": "packages/github" }, "scripts": { + "audit-moderate": "npm install && npm audit --audit-level=moderate", "build": "tsc", + "format": "prettier --write **/*.ts", + "format-check": "prettier --check **/*.ts", "test": "jest", "tsc": "tsc" }, - "version": "1.1.0" + "types": "lib/github.d.ts", + "version": "2.2.0" } diff --git a/node_modules/@octokit/endpoint/README.md b/node_modules/@octokit/endpoint/README.md index 5ac8429..498be29 100644 --- a/node_modules/@octokit/endpoint/README.md +++ b/node_modules/@octokit/endpoint/README.md @@ -61,10 +61,10 @@ Example for [List organization repositories](https://developer.github.com/v3/rep ```js const requestOptions = endpoint("GET /orgs/:org/repos", { headers: { - authorization: "token 0000000000000000000000000000000000000001" + authorization: "token 0000000000000000000000000000000000000001", }, org: "octokit", - type: "private" + type: "private", }); ``` @@ -283,10 +283,10 @@ const myEndpoint = require("@octokit/endpoint").defaults({ baseUrl: "https://github-enterprise.acme-inc.com/api/v3", headers: { "user-agent": "myApp/1.2.3", - authorization: `token 0000000000000000000000000000000000000001` + authorization: `token 0000000000000000000000000000000000000001`, }, org: "my-project", - per_page: 100 + per_page: 100, }); request(myEndpoint(`GET /orgs/:org/repos`)); @@ -298,14 +298,14 @@ You can call `.defaults()` again on the returned method, the defaults will casca const myProjectEndpoint = endpoint.defaults({ baseUrl: "https://github-enterprise.acme-inc.com/api/v3", headers: { - "user-agent": "myApp/1.2.3" + "user-agent": "myApp/1.2.3", }, - org: "my-project" + org: "my-project", }); const myProjectEndpointWithAuth = myProjectEndpoint.defaults({ headers: { - authorization: `token 0000000000000000000000000000000000000001` - } + authorization: `token 0000000000000000000000000000000000000001`, + }, }); ``` @@ -320,7 +320,7 @@ The current default options. ```js endpoint.DEFAULTS.baseUrl; // https://api.github.com const myEndpoint = endpoint.defaults({ - baseUrl: "https://github-enterprise.acme-inc.com/api/v3" + baseUrl: "https://github-enterprise.acme-inc.com/api/v3", }); myEndpoint.DEFAULTS.baseUrl; // https://github-enterprise.acme-inc.com/api/v3 ``` @@ -333,16 +333,16 @@ Get the defaulted endpoint options, but without parsing them into request option const myProjectEndpoint = endpoint.defaults({ baseUrl: "https://github-enterprise.acme-inc.com/api/v3", headers: { - "user-agent": "myApp/1.2.3" + "user-agent": "myApp/1.2.3", }, - org: "my-project" + org: "my-project", }); myProjectEndpoint.merge("GET /orgs/:org/repos", { headers: { - authorization: `token 0000000000000000000000000000000000000001` + authorization: `token 0000000000000000000000000000000000000001`, }, org: "my-secret-project", - type: "private" + type: "private", }); // { @@ -377,8 +377,8 @@ const options = endpoint("POST /markdown/raw", { data: "Hello world github/linguist#1 **cool**, and #1!", headers: { accept: "text/html;charset=utf-8", - "content-type": "text/plain" - } + "content-type": "text/plain", + }, }); // options is @@ -409,9 +409,9 @@ endpoint( headers: { "content-type": "text/plain", "content-length": 14, - authorization: `token 0000000000000000000000000000000000000001` + authorization: `token 0000000000000000000000000000000000000001`, }, - data: "Hello, world!" + data: "Hello, world!", } ); ``` diff --git a/node_modules/@octokit/endpoint/dist-node/index.js b/node_modules/@octokit/endpoint/dist-node/index.js index 9218ced..a67ab68 100644 --- a/node_modules/@octokit/endpoint/dist-node/index.js +++ b/node_modules/@octokit/endpoint/dist-node/index.js @@ -355,7 +355,7 @@ function withDefaults(oldDefaults, newDefaults) { }); } -const VERSION = "5.5.1"; +const VERSION = "6.0.1"; const userAgent = `octokit-endpoint.js/${VERSION} ${universalUserAgent.getUserAgent()}`; // DEFAULTS has all properties set that EndpointOptions has, except url. // So we use RequestParameters and add method as additional required property. diff --git a/node_modules/@octokit/endpoint/dist-node/index.js.map b/node_modules/@octokit/endpoint/dist-node/index.js.map index d84c1b7..9d22b36 100644 --- a/node_modules/@octokit/endpoint/dist-node/index.js.map +++ b/node_modules/@octokit/endpoint/dist-node/index.js.map @@ -1 +1 @@ -{"version":3,"file":"index.js","sources":["../dist-src/util/lowercase-keys.js","../dist-src/util/merge-deep.js","../dist-src/merge.js","../dist-src/util/add-query-parameters.js","../dist-src/util/extract-url-variable-names.js","../dist-src/util/omit.js","../dist-src/util/url-template.js","../dist-src/parse.js","../dist-src/endpoint-with-defaults.js","../dist-src/with-defaults.js","../dist-src/version.js","../dist-src/defaults.js","../dist-src/index.js"],"sourcesContent":["export function lowercaseKeys(object) {\n if (!object) {\n return {};\n }\n return Object.keys(object).reduce((newObj, key) => {\n newObj[key.toLowerCase()] = object[key];\n return newObj;\n }, {});\n}\n","import isPlainObject from \"is-plain-object\";\nexport function mergeDeep(defaults, options) {\n const result = Object.assign({}, defaults);\n Object.keys(options).forEach(key => {\n if (isPlainObject(options[key])) {\n if (!(key in defaults))\n Object.assign(result, { [key]: options[key] });\n else\n result[key] = mergeDeep(defaults[key], options[key]);\n }\n else {\n Object.assign(result, { [key]: options[key] });\n }\n });\n return result;\n}\n","import { lowercaseKeys } from \"./util/lowercase-keys\";\nimport { mergeDeep } from \"./util/merge-deep\";\nexport function merge(defaults, route, options) {\n if (typeof route === \"string\") {\n let [method, url] = route.split(\" \");\n options = Object.assign(url ? { method, url } : { url: method }, options);\n }\n else {\n options = Object.assign({}, route);\n }\n // lowercase header names before merging with defaults to avoid duplicates\n options.headers = lowercaseKeys(options.headers);\n const mergedOptions = mergeDeep(defaults || {}, options);\n // mediaType.previews arrays are merged, instead of overwritten\n if (defaults && defaults.mediaType.previews.length) {\n mergedOptions.mediaType.previews = defaults.mediaType.previews\n .filter(preview => !mergedOptions.mediaType.previews.includes(preview))\n .concat(mergedOptions.mediaType.previews);\n }\n mergedOptions.mediaType.previews = mergedOptions.mediaType.previews.map((preview) => preview.replace(/-preview/, \"\"));\n return mergedOptions;\n}\n","export function addQueryParameters(url, parameters) {\n const separator = /\\?/.test(url) ? \"&\" : \"?\";\n const names = Object.keys(parameters);\n if (names.length === 0) {\n return url;\n }\n return (url +\n separator +\n names\n .map(name => {\n if (name === \"q\") {\n return (\"q=\" +\n parameters\n .q.split(\"+\")\n .map(encodeURIComponent)\n .join(\"+\"));\n }\n return `${name}=${encodeURIComponent(parameters[name])}`;\n })\n .join(\"&\"));\n}\n","const urlVariableRegex = /\\{[^}]+\\}/g;\nfunction removeNonChars(variableName) {\n return variableName.replace(/^\\W+|\\W+$/g, \"\").split(/,/);\n}\nexport function extractUrlVariableNames(url) {\n const matches = url.match(urlVariableRegex);\n if (!matches) {\n return [];\n }\n return matches.map(removeNonChars).reduce((a, b) => a.concat(b), []);\n}\n","export function omit(object, keysToOmit) {\n return Object.keys(object)\n .filter(option => !keysToOmit.includes(option))\n .reduce((obj, key) => {\n obj[key] = object[key];\n return obj;\n }, {});\n}\n","// Based on https://github.com/bramstein/url-template, licensed under BSD\n// TODO: create separate package.\n//\n// Copyright (c) 2012-2014, Bram Stein\n// All rights reserved.\n// Redistribution and use in source and binary forms, with or without\n// modification, are permitted provided that the following conditions\n// are met:\n// 1. Redistributions of source code must retain the above copyright\n// notice, this list of conditions and the following disclaimer.\n// 2. Redistributions in binary form must reproduce the above copyright\n// notice, this list of conditions and the following disclaimer in the\n// documentation and/or other materials provided with the distribution.\n// 3. The name of the author may not be used to endorse or promote products\n// derived from this software without specific prior written permission.\n// THIS SOFTWARE IS PROVIDED BY THE AUTHOR \"AS IS\" AND ANY EXPRESS OR IMPLIED\n// WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF\n// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO\n// EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,\n// INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,\n// BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,\n// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY\n// OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING\n// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,\n// EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n/* istanbul ignore file */\nfunction encodeReserved(str) {\n return str\n .split(/(%[0-9A-Fa-f]{2})/g)\n .map(function (part) {\n if (!/%[0-9A-Fa-f]/.test(part)) {\n part = encodeURI(part)\n .replace(/%5B/g, \"[\")\n .replace(/%5D/g, \"]\");\n }\n return part;\n })\n .join(\"\");\n}\nfunction encodeUnreserved(str) {\n return encodeURIComponent(str).replace(/[!'()*]/g, function (c) {\n return (\"%\" +\n c\n .charCodeAt(0)\n .toString(16)\n .toUpperCase());\n });\n}\nfunction encodeValue(operator, value, key) {\n value =\n operator === \"+\" || operator === \"#\"\n ? encodeReserved(value)\n : encodeUnreserved(value);\n if (key) {\n return encodeUnreserved(key) + \"=\" + value;\n }\n else {\n return value;\n }\n}\nfunction isDefined(value) {\n return value !== undefined && value !== null;\n}\nfunction isKeyOperator(operator) {\n return operator === \";\" || operator === \"&\" || operator === \"?\";\n}\nfunction getValues(context, operator, key, modifier) {\n var value = context[key], result = [];\n if (isDefined(value) && value !== \"\") {\n if (typeof value === \"string\" ||\n typeof value === \"number\" ||\n typeof value === \"boolean\") {\n value = value.toString();\n if (modifier && modifier !== \"*\") {\n value = value.substring(0, parseInt(modifier, 10));\n }\n result.push(encodeValue(operator, value, isKeyOperator(operator) ? key : \"\"));\n }\n else {\n if (modifier === \"*\") {\n if (Array.isArray(value)) {\n value.filter(isDefined).forEach(function (value) {\n result.push(encodeValue(operator, value, isKeyOperator(operator) ? key : \"\"));\n });\n }\n else {\n Object.keys(value).forEach(function (k) {\n if (isDefined(value[k])) {\n result.push(encodeValue(operator, value[k], k));\n }\n });\n }\n }\n else {\n const tmp = [];\n if (Array.isArray(value)) {\n value.filter(isDefined).forEach(function (value) {\n tmp.push(encodeValue(operator, value));\n });\n }\n else {\n Object.keys(value).forEach(function (k) {\n if (isDefined(value[k])) {\n tmp.push(encodeUnreserved(k));\n tmp.push(encodeValue(operator, value[k].toString()));\n }\n });\n }\n if (isKeyOperator(operator)) {\n result.push(encodeUnreserved(key) + \"=\" + tmp.join(\",\"));\n }\n else if (tmp.length !== 0) {\n result.push(tmp.join(\",\"));\n }\n }\n }\n }\n else {\n if (operator === \";\") {\n if (isDefined(value)) {\n result.push(encodeUnreserved(key));\n }\n }\n else if (value === \"\" && (operator === \"&\" || operator === \"?\")) {\n result.push(encodeUnreserved(key) + \"=\");\n }\n else if (value === \"\") {\n result.push(\"\");\n }\n }\n return result;\n}\nexport function parseUrl(template) {\n return {\n expand: expand.bind(null, template)\n };\n}\nfunction expand(template, context) {\n var operators = [\"+\", \"#\", \".\", \"/\", \";\", \"?\", \"&\"];\n return template.replace(/\\{([^\\{\\}]+)\\}|([^\\{\\}]+)/g, function (_, expression, literal) {\n if (expression) {\n let operator = \"\";\n const values = [];\n if (operators.indexOf(expression.charAt(0)) !== -1) {\n operator = expression.charAt(0);\n expression = expression.substr(1);\n }\n expression.split(/,/g).forEach(function (variable) {\n var tmp = /([^:\\*]*)(?::(\\d+)|(\\*))?/.exec(variable);\n values.push(getValues(context, operator, tmp[1], tmp[2] || tmp[3]));\n });\n if (operator && operator !== \"+\") {\n var separator = \",\";\n if (operator === \"?\") {\n separator = \"&\";\n }\n else if (operator !== \"#\") {\n separator = operator;\n }\n return (values.length !== 0 ? operator : \"\") + values.join(separator);\n }\n else {\n return values.join(\",\");\n }\n }\n else {\n return encodeReserved(literal);\n }\n });\n}\n","import { addQueryParameters } from \"./util/add-query-parameters\";\nimport { extractUrlVariableNames } from \"./util/extract-url-variable-names\";\nimport { omit } from \"./util/omit\";\nimport { parseUrl } from \"./util/url-template\";\nexport function parse(options) {\n // https://fetch.spec.whatwg.org/#methods\n let method = options.method.toUpperCase();\n // replace :varname with {varname} to make it RFC 6570 compatible\n let url = (options.url || \"/\").replace(/:([a-z]\\w+)/g, \"{+$1}\");\n let headers = Object.assign({}, options.headers);\n let body;\n let parameters = omit(options, [\n \"method\",\n \"baseUrl\",\n \"url\",\n \"headers\",\n \"request\",\n \"mediaType\"\n ]);\n // extract variable names from URL to calculate remaining variables later\n const urlVariableNames = extractUrlVariableNames(url);\n url = parseUrl(url).expand(parameters);\n if (!/^http/.test(url)) {\n url = options.baseUrl + url;\n }\n const omittedParameters = Object.keys(options)\n .filter(option => urlVariableNames.includes(option))\n .concat(\"baseUrl\");\n const remainingParameters = omit(parameters, omittedParameters);\n const isBinaryRequset = /application\\/octet-stream/i.test(headers.accept);\n if (!isBinaryRequset) {\n if (options.mediaType.format) {\n // e.g. application/vnd.github.v3+json => application/vnd.github.v3.raw\n headers.accept = headers.accept\n .split(/,/)\n .map(preview => preview.replace(/application\\/vnd(\\.\\w+)(\\.v3)?(\\.\\w+)?(\\+json)?$/, `application/vnd$1$2.${options.mediaType.format}`))\n .join(\",\");\n }\n if (options.mediaType.previews.length) {\n const previewsFromAcceptHeader = headers.accept.match(/[\\w-]+(?=-preview)/g) || [];\n headers.accept = previewsFromAcceptHeader\n .concat(options.mediaType.previews)\n .map(preview => {\n const format = options.mediaType.format\n ? `.${options.mediaType.format}`\n : \"+json\";\n return `application/vnd.github.${preview}-preview${format}`;\n })\n .join(\",\");\n }\n }\n // for GET/HEAD requests, set URL query parameters from remaining parameters\n // for PATCH/POST/PUT/DELETE requests, set request body from remaining parameters\n if ([\"GET\", \"HEAD\"].includes(method)) {\n url = addQueryParameters(url, remainingParameters);\n }\n else {\n if (\"data\" in remainingParameters) {\n body = remainingParameters.data;\n }\n else {\n if (Object.keys(remainingParameters).length) {\n body = remainingParameters;\n }\n else {\n headers[\"content-length\"] = 0;\n }\n }\n }\n // default content-type for JSON if body is set\n if (!headers[\"content-type\"] && typeof body !== \"undefined\") {\n headers[\"content-type\"] = \"application/json; charset=utf-8\";\n }\n // GitHub expects 'content-length: 0' header for PUT/PATCH requests without body.\n // fetch does not allow to set `content-length` header, but we can set body to an empty string\n if ([\"PATCH\", \"PUT\"].includes(method) && typeof body === \"undefined\") {\n body = \"\";\n }\n // Only return body/request keys if present\n return Object.assign({ method, url, headers }, typeof body !== \"undefined\" ? { body } : null, options.request ? { request: options.request } : null);\n}\n","import { merge } from \"./merge\";\nimport { parse } from \"./parse\";\nexport function endpointWithDefaults(defaults, route, options) {\n return parse(merge(defaults, route, options));\n}\n","import { endpointWithDefaults } from \"./endpoint-with-defaults\";\nimport { merge } from \"./merge\";\nimport { parse } from \"./parse\";\nexport function withDefaults(oldDefaults, newDefaults) {\n const DEFAULTS = merge(oldDefaults, newDefaults);\n const endpoint = endpointWithDefaults.bind(null, DEFAULTS);\n return Object.assign(endpoint, {\n DEFAULTS,\n defaults: withDefaults.bind(null, DEFAULTS),\n merge: merge.bind(null, DEFAULTS),\n parse\n });\n}\n","export const VERSION = \"5.5.1\";\n","import { getUserAgent } from \"universal-user-agent\";\nimport { VERSION } from \"./version\";\nconst userAgent = `octokit-endpoint.js/${VERSION} ${getUserAgent()}`;\n// DEFAULTS has all properties set that EndpointOptions has, except url.\n// So we use RequestParameters and add method as additional required property.\nexport const DEFAULTS = {\n method: \"GET\",\n baseUrl: \"https://api.github.com\",\n headers: {\n accept: \"application/vnd.github.v3+json\",\n \"user-agent\": userAgent\n },\n mediaType: {\n format: \"\",\n previews: []\n }\n};\n","import { withDefaults } from \"./with-defaults\";\nimport { DEFAULTS } from \"./defaults\";\nexport const endpoint = withDefaults(null, DEFAULTS);\n"],"names":["lowercaseKeys","object","Object","keys","reduce","newObj","key","toLowerCase","mergeDeep","defaults","options","result","assign","forEach","isPlainObject","merge","route","method","url","split","headers","mergedOptions","mediaType","previews","length","filter","preview","includes","concat","map","replace","addQueryParameters","parameters","separator","test","names","name","q","encodeURIComponent","join","urlVariableRegex","removeNonChars","variableName","extractUrlVariableNames","matches","match","a","b","omit","keysToOmit","option","obj","encodeReserved","str","part","encodeURI","encodeUnreserved","c","charCodeAt","toString","toUpperCase","encodeValue","operator","value","isDefined","undefined","isKeyOperator","getValues","context","modifier","substring","parseInt","push","Array","isArray","k","tmp","parseUrl","template","expand","bind","operators","_","expression","literal","values","indexOf","charAt","substr","variable","exec","parse","body","urlVariableNames","baseUrl","omittedParameters","remainingParameters","isBinaryRequset","accept","format","previewsFromAcceptHeader","data","request","endpointWithDefaults","withDefaults","oldDefaults","newDefaults","DEFAULTS","endpoint","VERSION","userAgent","getUserAgent"],"mappings":";;;;;;;;;AAAO,SAASA,aAAT,CAAuBC,MAAvB,EAA+B;MAC9B,CAACA,MAAL,EAAa;WACF,EAAP;;;SAEGC,MAAM,CAACC,IAAP,CAAYF,MAAZ,EAAoBG,MAApB,CAA2B,CAACC,MAAD,EAASC,GAAT,KAAiB;IAC/CD,MAAM,CAACC,GAAG,CAACC,WAAJ,EAAD,CAAN,GAA4BN,MAAM,CAACK,GAAD,CAAlC;WACOD,MAAP;GAFG,EAGJ,EAHI,CAAP;;;ACHG,SAASG,SAAT,CAAmBC,QAAnB,EAA6BC,OAA7B,EAAsC;QACnCC,MAAM,GAAGT,MAAM,CAACU,MAAP,CAAc,EAAd,EAAkBH,QAAlB,CAAf;EACAP,MAAM,CAACC,IAAP,CAAYO,OAAZ,EAAqBG,OAArB,CAA6BP,GAAG,IAAI;QAC5BQ,aAAa,CAACJ,OAAO,CAACJ,GAAD,CAAR,CAAjB,EAAiC;UACzB,EAAEA,GAAG,IAAIG,QAAT,CAAJ,EACIP,MAAM,CAACU,MAAP,CAAcD,MAAd,EAAsB;SAAGL,GAAD,GAAOI,OAAO,CAACJ,GAAD;OAAtC,EADJ,KAGIK,MAAM,CAACL,GAAD,CAAN,GAAcE,SAAS,CAACC,QAAQ,CAACH,GAAD,CAAT,EAAgBI,OAAO,CAACJ,GAAD,CAAvB,CAAvB;KAJR,MAMK;MACDJ,MAAM,CAACU,MAAP,CAAcD,MAAd,EAAsB;SAAGL,GAAD,GAAOI,OAAO,CAACJ,GAAD;OAAtC;;GARR;SAWOK,MAAP;;;ACZG,SAASI,KAAT,CAAeN,QAAf,EAAyBO,KAAzB,EAAgCN,OAAhC,EAAyC;MACxC,OAAOM,KAAP,KAAiB,QAArB,EAA+B;QACvB,CAACC,MAAD,EAASC,GAAT,IAAgBF,KAAK,CAACG,KAAN,CAAY,GAAZ,CAApB;IACAT,OAAO,GAAGR,MAAM,CAACU,MAAP,CAAcM,GAAG,GAAG;MAAED,MAAF;MAAUC;KAAb,GAAqB;MAAEA,GAAG,EAAED;KAA7C,EAAuDP,OAAvD,CAAV;GAFJ,MAIK;IACDA,OAAO,GAAGR,MAAM,CAACU,MAAP,CAAc,EAAd,EAAkBI,KAAlB,CAAV;GANwC;;;EAS5CN,OAAO,CAACU,OAAR,GAAkBpB,aAAa,CAACU,OAAO,CAACU,OAAT,CAA/B;QACMC,aAAa,GAAGb,SAAS,CAACC,QAAQ,IAAI,EAAb,EAAiBC,OAAjB,CAA/B,CAV4C;;MAYxCD,QAAQ,IAAIA,QAAQ,CAACa,SAAT,CAAmBC,QAAnB,CAA4BC,MAA5C,EAAoD;IAChDH,aAAa,CAACC,SAAd,CAAwBC,QAAxB,GAAmCd,QAAQ,CAACa,SAAT,CAAmBC,QAAnB,CAC9BE,MAD8B,CACvBC,OAAO,IAAI,CAACL,aAAa,CAACC,SAAd,CAAwBC,QAAxB,CAAiCI,QAAjC,CAA0CD,OAA1C,CADW,EAE9BE,MAF8B,CAEvBP,aAAa,CAACC,SAAd,CAAwBC,QAFD,CAAnC;;;EAIJF,aAAa,CAACC,SAAd,CAAwBC,QAAxB,GAAmCF,aAAa,CAACC,SAAd,CAAwBC,QAAxB,CAAiCM,GAAjC,CAAsCH,OAAD,IAAaA,OAAO,CAACI,OAAR,CAAgB,UAAhB,EAA4B,EAA5B,CAAlD,CAAnC;SACOT,aAAP;;;ACpBG,SAASU,kBAAT,CAA4Bb,GAA5B,EAAiCc,UAAjC,EAA6C;QAC1CC,SAAS,GAAG,KAAKC,IAAL,CAAUhB,GAAV,IAAiB,GAAjB,GAAuB,GAAzC;QACMiB,KAAK,GAAGjC,MAAM,CAACC,IAAP,CAAY6B,UAAZ,CAAd;;MACIG,KAAK,CAACX,MAAN,KAAiB,CAArB,EAAwB;WACbN,GAAP;;;SAEIA,GAAG,GACPe,SADI,GAEJE,KAAK,CACAN,GADL,CACSO,IAAI,IAAI;QACTA,IAAI,KAAK,GAAb,EAAkB;aACN,OACJJ,UAAU,CACLK,CADL,CACOlB,KADP,CACa,GADb,EAEKU,GAFL,CAESS,kBAFT,EAGKC,IAHL,CAGU,GAHV,CADJ;;;WAMI,GAAEH,IAAK,IAAGE,kBAAkB,CAACN,UAAU,CAACI,IAAD,CAAX,CAAmB,EAAvD;GATJ,EAWKG,IAXL,CAWU,GAXV,CAFJ;;;ACNJ,MAAMC,gBAAgB,GAAG,YAAzB;;AACA,SAASC,cAAT,CAAwBC,YAAxB,EAAsC;SAC3BA,YAAY,CAACZ,OAAb,CAAqB,YAArB,EAAmC,EAAnC,EAAuCX,KAAvC,CAA6C,GAA7C,CAAP;;;AAEJ,AAAO,SAASwB,uBAAT,CAAiCzB,GAAjC,EAAsC;QACnC0B,OAAO,GAAG1B,GAAG,CAAC2B,KAAJ,CAAUL,gBAAV,CAAhB;;MACI,CAACI,OAAL,EAAc;WACH,EAAP;;;SAEGA,OAAO,CAACf,GAAR,CAAYY,cAAZ,EAA4BrC,MAA5B,CAAmC,CAAC0C,CAAD,EAAIC,CAAJ,KAAUD,CAAC,CAAClB,MAAF,CAASmB,CAAT,CAA7C,EAA0D,EAA1D,CAAP;;;ACTG,SAASC,IAAT,CAAc/C,MAAd,EAAsBgD,UAAtB,EAAkC;SAC9B/C,MAAM,CAACC,IAAP,CAAYF,MAAZ,EACFwB,MADE,CACKyB,MAAM,IAAI,CAACD,UAAU,CAACtB,QAAX,CAAoBuB,MAApB,CADhB,EAEF9C,MAFE,CAEK,CAAC+C,GAAD,EAAM7C,GAAN,KAAc;IACtB6C,GAAG,CAAC7C,GAAD,CAAH,GAAWL,MAAM,CAACK,GAAD,CAAjB;WACO6C,GAAP;GAJG,EAKJ,EALI,CAAP;;;ACDJ;;;;;;;;;;;;;;;;;;;;;;;;;;;AA0BA,SAASC,cAAT,CAAwBC,GAAxB,EAA6B;SAClBA,GAAG,CACLlC,KADE,CACI,oBADJ,EAEFU,GAFE,CAEE,UAAUyB,IAAV,EAAgB;QACjB,CAAC,eAAepB,IAAf,CAAoBoB,IAApB,CAAL,EAAgC;MAC5BA,IAAI,GAAGC,SAAS,CAACD,IAAD,CAAT,CACFxB,OADE,CACM,MADN,EACc,GADd,EAEFA,OAFE,CAEM,MAFN,EAEc,GAFd,CAAP;;;WAIGwB,IAAP;GARG,EAUFf,IAVE,CAUG,EAVH,CAAP;;;AAYJ,SAASiB,gBAAT,CAA0BH,GAA1B,EAA+B;SACpBf,kBAAkB,CAACe,GAAD,CAAlB,CAAwBvB,OAAxB,CAAgC,UAAhC,EAA4C,UAAU2B,CAAV,EAAa;WACpD,MACJA,CAAC,CACIC,UADL,CACgB,CADhB,EAEKC,QAFL,CAEc,EAFd,EAGKC,WAHL,EADJ;GADG,CAAP;;;AAQJ,SAASC,WAAT,CAAqBC,QAArB,EAA+BC,KAA/B,EAAsCzD,GAAtC,EAA2C;EACvCyD,KAAK,GACDD,QAAQ,KAAK,GAAb,IAAoBA,QAAQ,KAAK,GAAjC,GACMV,cAAc,CAACW,KAAD,CADpB,GAEMP,gBAAgB,CAACO,KAAD,CAH1B;;MAIIzD,GAAJ,EAAS;WACEkD,gBAAgB,CAAClD,GAAD,CAAhB,GAAwB,GAAxB,GAA8ByD,KAArC;GADJ,MAGK;WACMA,KAAP;;;;AAGR,SAASC,SAAT,CAAmBD,KAAnB,EAA0B;SACfA,KAAK,KAAKE,SAAV,IAAuBF,KAAK,KAAK,IAAxC;;;AAEJ,SAASG,aAAT,CAAuBJ,QAAvB,EAAiC;SACtBA,QAAQ,KAAK,GAAb,IAAoBA,QAAQ,KAAK,GAAjC,IAAwCA,QAAQ,KAAK,GAA5D;;;AAEJ,SAASK,SAAT,CAAmBC,OAAnB,EAA4BN,QAA5B,EAAsCxD,GAAtC,EAA2C+D,QAA3C,EAAqD;MAC7CN,KAAK,GAAGK,OAAO,CAAC9D,GAAD,CAAnB;MAA0BK,MAAM,GAAG,EAAnC;;MACIqD,SAAS,CAACD,KAAD,CAAT,IAAoBA,KAAK,KAAK,EAAlC,EAAsC;QAC9B,OAAOA,KAAP,KAAiB,QAAjB,IACA,OAAOA,KAAP,KAAiB,QADjB,IAEA,OAAOA,KAAP,KAAiB,SAFrB,EAEgC;MAC5BA,KAAK,GAAGA,KAAK,CAACJ,QAAN,EAAR;;UACIU,QAAQ,IAAIA,QAAQ,KAAK,GAA7B,EAAkC;QAC9BN,KAAK,GAAGA,KAAK,CAACO,SAAN,CAAgB,CAAhB,EAAmBC,QAAQ,CAACF,QAAD,EAAW,EAAX,CAA3B,CAAR;;;MAEJ1D,MAAM,CAAC6D,IAAP,CAAYX,WAAW,CAACC,QAAD,EAAWC,KAAX,EAAkBG,aAAa,CAACJ,QAAD,CAAb,GAA0BxD,GAA1B,GAAgC,EAAlD,CAAvB;KAPJ,MASK;UACG+D,QAAQ,KAAK,GAAjB,EAAsB;YACdI,KAAK,CAACC,OAAN,CAAcX,KAAd,CAAJ,EAA0B;UACtBA,KAAK,CAACtC,MAAN,CAAauC,SAAb,EAAwBnD,OAAxB,CAAgC,UAAUkD,KAAV,EAAiB;YAC7CpD,MAAM,CAAC6D,IAAP,CAAYX,WAAW,CAACC,QAAD,EAAWC,KAAX,EAAkBG,aAAa,CAACJ,QAAD,CAAb,GAA0BxD,GAA1B,GAAgC,EAAlD,CAAvB;WADJ;SADJ,MAKK;UACDJ,MAAM,CAACC,IAAP,CAAY4D,KAAZ,EAAmBlD,OAAnB,CAA2B,UAAU8D,CAAV,EAAa;gBAChCX,SAAS,CAACD,KAAK,CAACY,CAAD,CAAN,CAAb,EAAyB;cACrBhE,MAAM,CAAC6D,IAAP,CAAYX,WAAW,CAACC,QAAD,EAAWC,KAAK,CAACY,CAAD,CAAhB,EAAqBA,CAArB,CAAvB;;WAFR;;OAPR,MAcK;cACKC,GAAG,GAAG,EAAZ;;YACIH,KAAK,CAACC,OAAN,CAAcX,KAAd,CAAJ,EAA0B;UACtBA,KAAK,CAACtC,MAAN,CAAauC,SAAb,EAAwBnD,OAAxB,CAAgC,UAAUkD,KAAV,EAAiB;YAC7Ca,GAAG,CAACJ,IAAJ,CAASX,WAAW,CAACC,QAAD,EAAWC,KAAX,CAApB;WADJ;SADJ,MAKK;UACD7D,MAAM,CAACC,IAAP,CAAY4D,KAAZ,EAAmBlD,OAAnB,CAA2B,UAAU8D,CAAV,EAAa;gBAChCX,SAAS,CAACD,KAAK,CAACY,CAAD,CAAN,CAAb,EAAyB;cACrBC,GAAG,CAACJ,IAAJ,CAAShB,gBAAgB,CAACmB,CAAD,CAAzB;cACAC,GAAG,CAACJ,IAAJ,CAASX,WAAW,CAACC,QAAD,EAAWC,KAAK,CAACY,CAAD,CAAL,CAAShB,QAAT,EAAX,CAApB;;WAHR;;;YAOAO,aAAa,CAACJ,QAAD,CAAjB,EAA6B;UACzBnD,MAAM,CAAC6D,IAAP,CAAYhB,gBAAgB,CAAClD,GAAD,CAAhB,GAAwB,GAAxB,GAA8BsE,GAAG,CAACrC,IAAJ,CAAS,GAAT,CAA1C;SADJ,MAGK,IAAIqC,GAAG,CAACpD,MAAJ,KAAe,CAAnB,EAAsB;UACvBb,MAAM,CAAC6D,IAAP,CAAYI,GAAG,CAACrC,IAAJ,CAAS,GAAT,CAAZ;;;;GA5ChB,MAiDK;QACGuB,QAAQ,KAAK,GAAjB,EAAsB;UACdE,SAAS,CAACD,KAAD,CAAb,EAAsB;QAClBpD,MAAM,CAAC6D,IAAP,CAAYhB,gBAAgB,CAAClD,GAAD,CAA5B;;KAFR,MAKK,IAAIyD,KAAK,KAAK,EAAV,KAAiBD,QAAQ,KAAK,GAAb,IAAoBA,QAAQ,KAAK,GAAlD,CAAJ,EAA4D;MAC7DnD,MAAM,CAAC6D,IAAP,CAAYhB,gBAAgB,CAAClD,GAAD,CAAhB,GAAwB,GAApC;KADC,MAGA,IAAIyD,KAAK,KAAK,EAAd,EAAkB;MACnBpD,MAAM,CAAC6D,IAAP,CAAY,EAAZ;;;;SAGD7D,MAAP;;;AAEJ,AAAO,SAASkE,QAAT,CAAkBC,QAAlB,EAA4B;SACxB;IACHC,MAAM,EAAEA,MAAM,CAACC,IAAP,CAAY,IAAZ,EAAkBF,QAAlB;GADZ;;;AAIJ,SAASC,MAAT,CAAgBD,QAAhB,EAA0BV,OAA1B,EAAmC;MAC3Ba,SAAS,GAAG,CAAC,GAAD,EAAM,GAAN,EAAW,GAAX,EAAgB,GAAhB,EAAqB,GAArB,EAA0B,GAA1B,EAA+B,GAA/B,CAAhB;SACOH,QAAQ,CAAChD,OAAT,CAAiB,4BAAjB,EAA+C,UAAUoD,CAAV,EAAaC,UAAb,EAAyBC,OAAzB,EAAkC;QAChFD,UAAJ,EAAgB;UACRrB,QAAQ,GAAG,EAAf;YACMuB,MAAM,GAAG,EAAf;;UACIJ,SAAS,CAACK,OAAV,CAAkBH,UAAU,CAACI,MAAX,CAAkB,CAAlB,CAAlB,MAA4C,CAAC,CAAjD,EAAoD;QAChDzB,QAAQ,GAAGqB,UAAU,CAACI,MAAX,CAAkB,CAAlB,CAAX;QACAJ,UAAU,GAAGA,UAAU,CAACK,MAAX,CAAkB,CAAlB,CAAb;;;MAEJL,UAAU,CAAChE,KAAX,CAAiB,IAAjB,EAAuBN,OAAvB,CAA+B,UAAU4E,QAAV,EAAoB;YAC3Cb,GAAG,GAAG,4BAA4Bc,IAA5B,CAAiCD,QAAjC,CAAV;QACAJ,MAAM,CAACb,IAAP,CAAYL,SAAS,CAACC,OAAD,EAAUN,QAAV,EAAoBc,GAAG,CAAC,CAAD,CAAvB,EAA4BA,GAAG,CAAC,CAAD,CAAH,IAAUA,GAAG,CAAC,CAAD,CAAzC,CAArB;OAFJ;;UAIId,QAAQ,IAAIA,QAAQ,KAAK,GAA7B,EAAkC;YAC1B7B,SAAS,GAAG,GAAhB;;YACI6B,QAAQ,KAAK,GAAjB,EAAsB;UAClB7B,SAAS,GAAG,GAAZ;SADJ,MAGK,IAAI6B,QAAQ,KAAK,GAAjB,EAAsB;UACvB7B,SAAS,GAAG6B,QAAZ;;;eAEG,CAACuB,MAAM,CAAC7D,MAAP,KAAkB,CAAlB,GAAsBsC,QAAtB,GAAiC,EAAlC,IAAwCuB,MAAM,CAAC9C,IAAP,CAAYN,SAAZ,CAA/C;OARJ,MAUK;eACMoD,MAAM,CAAC9C,IAAP,CAAY,GAAZ,CAAP;;KAtBR,MAyBK;aACMa,cAAc,CAACgC,OAAD,CAArB;;GA3BD,CAAP;;;ACvIG,SAASO,KAAT,CAAejF,OAAf,EAAwB;;MAEvBO,MAAM,GAAGP,OAAO,CAACO,MAAR,CAAe2C,WAAf,EAAb,CAF2B;;MAIvB1C,GAAG,GAAG,CAACR,OAAO,CAACQ,GAAR,IAAe,GAAhB,EAAqBY,OAArB,CAA6B,cAA7B,EAA6C,OAA7C,CAAV;MACIV,OAAO,GAAGlB,MAAM,CAACU,MAAP,CAAc,EAAd,EAAkBF,OAAO,CAACU,OAA1B,CAAd;MACIwE,IAAJ;MACI5D,UAAU,GAAGgB,IAAI,CAACtC,OAAD,EAAU,CAC3B,QAD2B,EAE3B,SAF2B,EAG3B,KAH2B,EAI3B,SAJ2B,EAK3B,SAL2B,EAM3B,WAN2B,CAAV,CAArB,CAP2B;;QAgBrBmF,gBAAgB,GAAGlD,uBAAuB,CAACzB,GAAD,CAAhD;EACAA,GAAG,GAAG2D,QAAQ,CAAC3D,GAAD,CAAR,CAAc6D,MAAd,CAAqB/C,UAArB,CAAN;;MACI,CAAC,QAAQE,IAAR,CAAahB,GAAb,CAAL,EAAwB;IACpBA,GAAG,GAAGR,OAAO,CAACoF,OAAR,GAAkB5E,GAAxB;;;QAEE6E,iBAAiB,GAAG7F,MAAM,CAACC,IAAP,CAAYO,OAAZ,EACrBe,MADqB,CACdyB,MAAM,IAAI2C,gBAAgB,CAAClE,QAAjB,CAA0BuB,MAA1B,CADI,EAErBtB,MAFqB,CAEd,SAFc,CAA1B;QAGMoE,mBAAmB,GAAGhD,IAAI,CAAChB,UAAD,EAAa+D,iBAAb,CAAhC;QACME,eAAe,GAAG,6BAA6B/D,IAA7B,CAAkCd,OAAO,CAAC8E,MAA1C,CAAxB;;MACI,CAACD,eAAL,EAAsB;QACdvF,OAAO,CAACY,SAAR,CAAkB6E,MAAtB,EAA8B;;MAE1B/E,OAAO,CAAC8E,MAAR,GAAiB9E,OAAO,CAAC8E,MAAR,CACZ/E,KADY,CACN,GADM,EAEZU,GAFY,CAERH,OAAO,IAAIA,OAAO,CAACI,OAAR,CAAgB,kDAAhB,EAAqE,uBAAsBpB,OAAO,CAACY,SAAR,CAAkB6E,MAAO,EAApH,CAFH,EAGZ5D,IAHY,CAGP,GAHO,CAAjB;;;QAKA7B,OAAO,CAACY,SAAR,CAAkBC,QAAlB,CAA2BC,MAA/B,EAAuC;YAC7B4E,wBAAwB,GAAGhF,OAAO,CAAC8E,MAAR,CAAerD,KAAf,CAAqB,qBAArB,KAA+C,EAAhF;MACAzB,OAAO,CAAC8E,MAAR,GAAiBE,wBAAwB,CACpCxE,MADY,CACLlB,OAAO,CAACY,SAAR,CAAkBC,QADb,EAEZM,GAFY,CAERH,OAAO,IAAI;cACVyE,MAAM,GAAGzF,OAAO,CAACY,SAAR,CAAkB6E,MAAlB,GACR,IAAGzF,OAAO,CAACY,SAAR,CAAkB6E,MAAO,EADpB,GAET,OAFN;eAGQ,0BAAyBzE,OAAQ,WAAUyE,MAAO,EAA1D;OANa,EAQZ5D,IARY,CAQP,GARO,CAAjB;;GApCmB;;;;MAiDvB,CAAC,KAAD,EAAQ,MAAR,EAAgBZ,QAAhB,CAAyBV,MAAzB,CAAJ,EAAsC;IAClCC,GAAG,GAAGa,kBAAkB,CAACb,GAAD,EAAM8E,mBAAN,CAAxB;GADJ,MAGK;QACG,UAAUA,mBAAd,EAAmC;MAC/BJ,IAAI,GAAGI,mBAAmB,CAACK,IAA3B;KADJ,MAGK;UACGnG,MAAM,CAACC,IAAP,CAAY6F,mBAAZ,EAAiCxE,MAArC,EAA6C;QACzCoE,IAAI,GAAGI,mBAAP;OADJ,MAGK;QACD5E,OAAO,CAAC,gBAAD,CAAP,GAA4B,CAA5B;;;GA7De;;;MAkEvB,CAACA,OAAO,CAAC,cAAD,CAAR,IAA4B,OAAOwE,IAAP,KAAgB,WAAhD,EAA6D;IACzDxE,OAAO,CAAC,cAAD,CAAP,GAA0B,iCAA1B;GAnEuB;;;;MAuEvB,CAAC,OAAD,EAAU,KAAV,EAAiBO,QAAjB,CAA0BV,MAA1B,KAAqC,OAAO2E,IAAP,KAAgB,WAAzD,EAAsE;IAClEA,IAAI,GAAG,EAAP;GAxEuB;;;SA2EpB1F,MAAM,CAACU,MAAP,CAAc;IAAEK,MAAF;IAAUC,GAAV;IAAeE;GAA7B,EAAwC,OAAOwE,IAAP,KAAgB,WAAhB,GAA8B;IAAEA;GAAhC,GAAyC,IAAjF,EAAuFlF,OAAO,CAAC4F,OAAR,GAAkB;IAAEA,OAAO,EAAE5F,OAAO,CAAC4F;GAArC,GAAiD,IAAxI,CAAP;;;AC7EG,SAASC,oBAAT,CAA8B9F,QAA9B,EAAwCO,KAAxC,EAA+CN,OAA/C,EAAwD;SACpDiF,KAAK,CAAC5E,KAAK,CAACN,QAAD,EAAWO,KAAX,EAAkBN,OAAlB,CAAN,CAAZ;;;ACAG,SAAS8F,YAAT,CAAsBC,WAAtB,EAAmCC,WAAnC,EAAgD;QAC7CC,QAAQ,GAAG5F,KAAK,CAAC0F,WAAD,EAAcC,WAAd,CAAtB;QACME,QAAQ,GAAGL,oBAAoB,CAACvB,IAArB,CAA0B,IAA1B,EAAgC2B,QAAhC,CAAjB;SACOzG,MAAM,CAACU,MAAP,CAAcgG,QAAd,EAAwB;IAC3BD,QAD2B;IAE3BlG,QAAQ,EAAE+F,YAAY,CAACxB,IAAb,CAAkB,IAAlB,EAAwB2B,QAAxB,CAFiB;IAG3B5F,KAAK,EAAEA,KAAK,CAACiE,IAAN,CAAW,IAAX,EAAiB2B,QAAjB,CAHoB;IAI3BhB;GAJG,CAAP;;;ACNG,MAAMkB,OAAO,GAAG,mBAAhB;;ACEP,MAAMC,SAAS,GAAI,uBAAsBD,OAAQ,IAAGE,+BAAY,EAAG,EAAnE;;;AAGA,AAAO,MAAMJ,QAAQ,GAAG;EACpB1F,MAAM,EAAE,KADY;EAEpB6E,OAAO,EAAE,wBAFW;EAGpB1E,OAAO,EAAE;IACL8E,MAAM,EAAE,gCADH;kBAESY;GALE;EAOpBxF,SAAS,EAAE;IACP6E,MAAM,EAAE,EADD;IAEP5E,QAAQ,EAAE;;CATX;;MCHMqF,QAAQ,GAAGJ,YAAY,CAAC,IAAD,EAAOG,QAAP,CAA7B;;;;"} \ No newline at end of file +{"version":3,"file":"index.js","sources":["../dist-src/util/lowercase-keys.js","../dist-src/util/merge-deep.js","../dist-src/merge.js","../dist-src/util/add-query-parameters.js","../dist-src/util/extract-url-variable-names.js","../dist-src/util/omit.js","../dist-src/util/url-template.js","../dist-src/parse.js","../dist-src/endpoint-with-defaults.js","../dist-src/with-defaults.js","../dist-src/version.js","../dist-src/defaults.js","../dist-src/index.js"],"sourcesContent":["export function lowercaseKeys(object) {\n if (!object) {\n return {};\n }\n return Object.keys(object).reduce((newObj, key) => {\n newObj[key.toLowerCase()] = object[key];\n return newObj;\n }, {});\n}\n","import isPlainObject from \"is-plain-object\";\nexport function mergeDeep(defaults, options) {\n const result = Object.assign({}, defaults);\n Object.keys(options).forEach((key) => {\n if (isPlainObject(options[key])) {\n if (!(key in defaults))\n Object.assign(result, { [key]: options[key] });\n else\n result[key] = mergeDeep(defaults[key], options[key]);\n }\n else {\n Object.assign(result, { [key]: options[key] });\n }\n });\n return result;\n}\n","import { lowercaseKeys } from \"./util/lowercase-keys\";\nimport { mergeDeep } from \"./util/merge-deep\";\nexport function merge(defaults, route, options) {\n if (typeof route === \"string\") {\n let [method, url] = route.split(\" \");\n options = Object.assign(url ? { method, url } : { url: method }, options);\n }\n else {\n options = Object.assign({}, route);\n }\n // lowercase header names before merging with defaults to avoid duplicates\n options.headers = lowercaseKeys(options.headers);\n const mergedOptions = mergeDeep(defaults || {}, options);\n // mediaType.previews arrays are merged, instead of overwritten\n if (defaults && defaults.mediaType.previews.length) {\n mergedOptions.mediaType.previews = defaults.mediaType.previews\n .filter((preview) => !mergedOptions.mediaType.previews.includes(preview))\n .concat(mergedOptions.mediaType.previews);\n }\n mergedOptions.mediaType.previews = mergedOptions.mediaType.previews.map((preview) => preview.replace(/-preview/, \"\"));\n return mergedOptions;\n}\n","export function addQueryParameters(url, parameters) {\n const separator = /\\?/.test(url) ? \"&\" : \"?\";\n const names = Object.keys(parameters);\n if (names.length === 0) {\n return url;\n }\n return (url +\n separator +\n names\n .map((name) => {\n if (name === \"q\") {\n return (\"q=\" + parameters.q.split(\"+\").map(encodeURIComponent).join(\"+\"));\n }\n return `${name}=${encodeURIComponent(parameters[name])}`;\n })\n .join(\"&\"));\n}\n","const urlVariableRegex = /\\{[^}]+\\}/g;\nfunction removeNonChars(variableName) {\n return variableName.replace(/^\\W+|\\W+$/g, \"\").split(/,/);\n}\nexport function extractUrlVariableNames(url) {\n const matches = url.match(urlVariableRegex);\n if (!matches) {\n return [];\n }\n return matches.map(removeNonChars).reduce((a, b) => a.concat(b), []);\n}\n","export function omit(object, keysToOmit) {\n return Object.keys(object)\n .filter((option) => !keysToOmit.includes(option))\n .reduce((obj, key) => {\n obj[key] = object[key];\n return obj;\n }, {});\n}\n","// Based on https://github.com/bramstein/url-template, licensed under BSD\n// TODO: create separate package.\n//\n// Copyright (c) 2012-2014, Bram Stein\n// All rights reserved.\n// Redistribution and use in source and binary forms, with or without\n// modification, are permitted provided that the following conditions\n// are met:\n// 1. Redistributions of source code must retain the above copyright\n// notice, this list of conditions and the following disclaimer.\n// 2. Redistributions in binary form must reproduce the above copyright\n// notice, this list of conditions and the following disclaimer in the\n// documentation and/or other materials provided with the distribution.\n// 3. The name of the author may not be used to endorse or promote products\n// derived from this software without specific prior written permission.\n// THIS SOFTWARE IS PROVIDED BY THE AUTHOR \"AS IS\" AND ANY EXPRESS OR IMPLIED\n// WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF\n// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO\n// EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,\n// INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,\n// BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,\n// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY\n// OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING\n// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,\n// EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n/* istanbul ignore file */\nfunction encodeReserved(str) {\n return str\n .split(/(%[0-9A-Fa-f]{2})/g)\n .map(function (part) {\n if (!/%[0-9A-Fa-f]/.test(part)) {\n part = encodeURI(part).replace(/%5B/g, \"[\").replace(/%5D/g, \"]\");\n }\n return part;\n })\n .join(\"\");\n}\nfunction encodeUnreserved(str) {\n return encodeURIComponent(str).replace(/[!'()*]/g, function (c) {\n return \"%\" + c.charCodeAt(0).toString(16).toUpperCase();\n });\n}\nfunction encodeValue(operator, value, key) {\n value =\n operator === \"+\" || operator === \"#\"\n ? encodeReserved(value)\n : encodeUnreserved(value);\n if (key) {\n return encodeUnreserved(key) + \"=\" + value;\n }\n else {\n return value;\n }\n}\nfunction isDefined(value) {\n return value !== undefined && value !== null;\n}\nfunction isKeyOperator(operator) {\n return operator === \";\" || operator === \"&\" || operator === \"?\";\n}\nfunction getValues(context, operator, key, modifier) {\n var value = context[key], result = [];\n if (isDefined(value) && value !== \"\") {\n if (typeof value === \"string\" ||\n typeof value === \"number\" ||\n typeof value === \"boolean\") {\n value = value.toString();\n if (modifier && modifier !== \"*\") {\n value = value.substring(0, parseInt(modifier, 10));\n }\n result.push(encodeValue(operator, value, isKeyOperator(operator) ? key : \"\"));\n }\n else {\n if (modifier === \"*\") {\n if (Array.isArray(value)) {\n value.filter(isDefined).forEach(function (value) {\n result.push(encodeValue(operator, value, isKeyOperator(operator) ? key : \"\"));\n });\n }\n else {\n Object.keys(value).forEach(function (k) {\n if (isDefined(value[k])) {\n result.push(encodeValue(operator, value[k], k));\n }\n });\n }\n }\n else {\n const tmp = [];\n if (Array.isArray(value)) {\n value.filter(isDefined).forEach(function (value) {\n tmp.push(encodeValue(operator, value));\n });\n }\n else {\n Object.keys(value).forEach(function (k) {\n if (isDefined(value[k])) {\n tmp.push(encodeUnreserved(k));\n tmp.push(encodeValue(operator, value[k].toString()));\n }\n });\n }\n if (isKeyOperator(operator)) {\n result.push(encodeUnreserved(key) + \"=\" + tmp.join(\",\"));\n }\n else if (tmp.length !== 0) {\n result.push(tmp.join(\",\"));\n }\n }\n }\n }\n else {\n if (operator === \";\") {\n if (isDefined(value)) {\n result.push(encodeUnreserved(key));\n }\n }\n else if (value === \"\" && (operator === \"&\" || operator === \"?\")) {\n result.push(encodeUnreserved(key) + \"=\");\n }\n else if (value === \"\") {\n result.push(\"\");\n }\n }\n return result;\n}\nexport function parseUrl(template) {\n return {\n expand: expand.bind(null, template),\n };\n}\nfunction expand(template, context) {\n var operators = [\"+\", \"#\", \".\", \"/\", \";\", \"?\", \"&\"];\n return template.replace(/\\{([^\\{\\}]+)\\}|([^\\{\\}]+)/g, function (_, expression, literal) {\n if (expression) {\n let operator = \"\";\n const values = [];\n if (operators.indexOf(expression.charAt(0)) !== -1) {\n operator = expression.charAt(0);\n expression = expression.substr(1);\n }\n expression.split(/,/g).forEach(function (variable) {\n var tmp = /([^:\\*]*)(?::(\\d+)|(\\*))?/.exec(variable);\n values.push(getValues(context, operator, tmp[1], tmp[2] || tmp[3]));\n });\n if (operator && operator !== \"+\") {\n var separator = \",\";\n if (operator === \"?\") {\n separator = \"&\";\n }\n else if (operator !== \"#\") {\n separator = operator;\n }\n return (values.length !== 0 ? operator : \"\") + values.join(separator);\n }\n else {\n return values.join(\",\");\n }\n }\n else {\n return encodeReserved(literal);\n }\n });\n}\n","import { addQueryParameters } from \"./util/add-query-parameters\";\nimport { extractUrlVariableNames } from \"./util/extract-url-variable-names\";\nimport { omit } from \"./util/omit\";\nimport { parseUrl } from \"./util/url-template\";\nexport function parse(options) {\n // https://fetch.spec.whatwg.org/#methods\n let method = options.method.toUpperCase();\n // replace :varname with {varname} to make it RFC 6570 compatible\n let url = (options.url || \"/\").replace(/:([a-z]\\w+)/g, \"{+$1}\");\n let headers = Object.assign({}, options.headers);\n let body;\n let parameters = omit(options, [\n \"method\",\n \"baseUrl\",\n \"url\",\n \"headers\",\n \"request\",\n \"mediaType\",\n ]);\n // extract variable names from URL to calculate remaining variables later\n const urlVariableNames = extractUrlVariableNames(url);\n url = parseUrl(url).expand(parameters);\n if (!/^http/.test(url)) {\n url = options.baseUrl + url;\n }\n const omittedParameters = Object.keys(options)\n .filter((option) => urlVariableNames.includes(option))\n .concat(\"baseUrl\");\n const remainingParameters = omit(parameters, omittedParameters);\n const isBinaryRequset = /application\\/octet-stream/i.test(headers.accept);\n if (!isBinaryRequset) {\n if (options.mediaType.format) {\n // e.g. application/vnd.github.v3+json => application/vnd.github.v3.raw\n headers.accept = headers.accept\n .split(/,/)\n .map((preview) => preview.replace(/application\\/vnd(\\.\\w+)(\\.v3)?(\\.\\w+)?(\\+json)?$/, `application/vnd$1$2.${options.mediaType.format}`))\n .join(\",\");\n }\n if (options.mediaType.previews.length) {\n const previewsFromAcceptHeader = headers.accept.match(/[\\w-]+(?=-preview)/g) || [];\n headers.accept = previewsFromAcceptHeader\n .concat(options.mediaType.previews)\n .map((preview) => {\n const format = options.mediaType.format\n ? `.${options.mediaType.format}`\n : \"+json\";\n return `application/vnd.github.${preview}-preview${format}`;\n })\n .join(\",\");\n }\n }\n // for GET/HEAD requests, set URL query parameters from remaining parameters\n // for PATCH/POST/PUT/DELETE requests, set request body from remaining parameters\n if ([\"GET\", \"HEAD\"].includes(method)) {\n url = addQueryParameters(url, remainingParameters);\n }\n else {\n if (\"data\" in remainingParameters) {\n body = remainingParameters.data;\n }\n else {\n if (Object.keys(remainingParameters).length) {\n body = remainingParameters;\n }\n else {\n headers[\"content-length\"] = 0;\n }\n }\n }\n // default content-type for JSON if body is set\n if (!headers[\"content-type\"] && typeof body !== \"undefined\") {\n headers[\"content-type\"] = \"application/json; charset=utf-8\";\n }\n // GitHub expects 'content-length: 0' header for PUT/PATCH requests without body.\n // fetch does not allow to set `content-length` header, but we can set body to an empty string\n if ([\"PATCH\", \"PUT\"].includes(method) && typeof body === \"undefined\") {\n body = \"\";\n }\n // Only return body/request keys if present\n return Object.assign({ method, url, headers }, typeof body !== \"undefined\" ? { body } : null, options.request ? { request: options.request } : null);\n}\n","import { merge } from \"./merge\";\nimport { parse } from \"./parse\";\nexport function endpointWithDefaults(defaults, route, options) {\n return parse(merge(defaults, route, options));\n}\n","import { endpointWithDefaults } from \"./endpoint-with-defaults\";\nimport { merge } from \"./merge\";\nimport { parse } from \"./parse\";\nexport function withDefaults(oldDefaults, newDefaults) {\n const DEFAULTS = merge(oldDefaults, newDefaults);\n const endpoint = endpointWithDefaults.bind(null, DEFAULTS);\n return Object.assign(endpoint, {\n DEFAULTS,\n defaults: withDefaults.bind(null, DEFAULTS),\n merge: merge.bind(null, DEFAULTS),\n parse,\n });\n}\n","export const VERSION = \"6.0.1\";\n","import { getUserAgent } from \"universal-user-agent\";\nimport { VERSION } from \"./version\";\nconst userAgent = `octokit-endpoint.js/${VERSION} ${getUserAgent()}`;\n// DEFAULTS has all properties set that EndpointOptions has, except url.\n// So we use RequestParameters and add method as additional required property.\nexport const DEFAULTS = {\n method: \"GET\",\n baseUrl: \"https://api.github.com\",\n headers: {\n accept: \"application/vnd.github.v3+json\",\n \"user-agent\": userAgent,\n },\n mediaType: {\n format: \"\",\n previews: [],\n },\n};\n","import { withDefaults } from \"./with-defaults\";\nimport { DEFAULTS } from \"./defaults\";\nexport const endpoint = withDefaults(null, DEFAULTS);\n"],"names":["lowercaseKeys","object","Object","keys","reduce","newObj","key","toLowerCase","mergeDeep","defaults","options","result","assign","forEach","isPlainObject","merge","route","method","url","split","headers","mergedOptions","mediaType","previews","length","filter","preview","includes","concat","map","replace","addQueryParameters","parameters","separator","test","names","name","q","encodeURIComponent","join","urlVariableRegex","removeNonChars","variableName","extractUrlVariableNames","matches","match","a","b","omit","keysToOmit","option","obj","encodeReserved","str","part","encodeURI","encodeUnreserved","c","charCodeAt","toString","toUpperCase","encodeValue","operator","value","isDefined","undefined","isKeyOperator","getValues","context","modifier","substring","parseInt","push","Array","isArray","k","tmp","parseUrl","template","expand","bind","operators","_","expression","literal","values","indexOf","charAt","substr","variable","exec","parse","body","urlVariableNames","baseUrl","omittedParameters","remainingParameters","isBinaryRequset","accept","format","previewsFromAcceptHeader","data","request","endpointWithDefaults","withDefaults","oldDefaults","newDefaults","DEFAULTS","endpoint","VERSION","userAgent","getUserAgent"],"mappings":";;;;;;;;;AAAO,SAASA,aAAT,CAAuBC,MAAvB,EAA+B;AAClC,MAAI,CAACA,MAAL,EAAa;AACT,WAAO,EAAP;AACH;;AACD,SAAOC,MAAM,CAACC,IAAP,CAAYF,MAAZ,EAAoBG,MAApB,CAA2B,CAACC,MAAD,EAASC,GAAT,KAAiB;AAC/CD,IAAAA,MAAM,CAACC,GAAG,CAACC,WAAJ,EAAD,CAAN,GAA4BN,MAAM,CAACK,GAAD,CAAlC;AACA,WAAOD,MAAP;AACH,GAHM,EAGJ,EAHI,CAAP;AAIH;;ACPM,SAASG,SAAT,CAAmBC,QAAnB,EAA6BC,OAA7B,EAAsC;AACzC,QAAMC,MAAM,GAAGT,MAAM,CAACU,MAAP,CAAc,EAAd,EAAkBH,QAAlB,CAAf;AACAP,EAAAA,MAAM,CAACC,IAAP,CAAYO,OAAZ,EAAqBG,OAArB,CAA8BP,GAAD,IAAS;AAClC,QAAIQ,aAAa,CAACJ,OAAO,CAACJ,GAAD,CAAR,CAAjB,EAAiC;AAC7B,UAAI,EAAEA,GAAG,IAAIG,QAAT,CAAJ,EACIP,MAAM,CAACU,MAAP,CAAcD,MAAd,EAAsB;AAAE,SAACL,GAAD,GAAOI,OAAO,CAACJ,GAAD;AAAhB,OAAtB,EADJ,KAGIK,MAAM,CAACL,GAAD,CAAN,GAAcE,SAAS,CAACC,QAAQ,CAACH,GAAD,CAAT,EAAgBI,OAAO,CAACJ,GAAD,CAAvB,CAAvB;AACP,KALD,MAMK;AACDJ,MAAAA,MAAM,CAACU,MAAP,CAAcD,MAAd,EAAsB;AAAE,SAACL,GAAD,GAAOI,OAAO,CAACJ,GAAD;AAAhB,OAAtB;AACH;AACJ,GAVD;AAWA,SAAOK,MAAP;AACH;;ACbM,SAASI,KAAT,CAAeN,QAAf,EAAyBO,KAAzB,EAAgCN,OAAhC,EAAyC;AAC5C,MAAI,OAAOM,KAAP,KAAiB,QAArB,EAA+B;AAC3B,QAAI,CAACC,MAAD,EAASC,GAAT,IAAgBF,KAAK,CAACG,KAAN,CAAY,GAAZ,CAApB;AACAT,IAAAA,OAAO,GAAGR,MAAM,CAACU,MAAP,CAAcM,GAAG,GAAG;AAAED,MAAAA,MAAF;AAAUC,MAAAA;AAAV,KAAH,GAAqB;AAAEA,MAAAA,GAAG,EAAED;AAAP,KAAtC,EAAuDP,OAAvD,CAAV;AACH,GAHD,MAIK;AACDA,IAAAA,OAAO,GAAGR,MAAM,CAACU,MAAP,CAAc,EAAd,EAAkBI,KAAlB,CAAV;AACH,GAP2C;;;AAS5CN,EAAAA,OAAO,CAACU,OAAR,GAAkBpB,aAAa,CAACU,OAAO,CAACU,OAAT,CAA/B;AACA,QAAMC,aAAa,GAAGb,SAAS,CAACC,QAAQ,IAAI,EAAb,EAAiBC,OAAjB,CAA/B,CAV4C;;AAY5C,MAAID,QAAQ,IAAIA,QAAQ,CAACa,SAAT,CAAmBC,QAAnB,CAA4BC,MAA5C,EAAoD;AAChDH,IAAAA,aAAa,CAACC,SAAd,CAAwBC,QAAxB,GAAmCd,QAAQ,CAACa,SAAT,CAAmBC,QAAnB,CAC9BE,MAD8B,CACtBC,OAAD,IAAa,CAACL,aAAa,CAACC,SAAd,CAAwBC,QAAxB,CAAiCI,QAAjC,CAA0CD,OAA1C,CADS,EAE9BE,MAF8B,CAEvBP,aAAa,CAACC,SAAd,CAAwBC,QAFD,CAAnC;AAGH;;AACDF,EAAAA,aAAa,CAACC,SAAd,CAAwBC,QAAxB,GAAmCF,aAAa,CAACC,SAAd,CAAwBC,QAAxB,CAAiCM,GAAjC,CAAsCH,OAAD,IAAaA,OAAO,CAACI,OAAR,CAAgB,UAAhB,EAA4B,EAA5B,CAAlD,CAAnC;AACA,SAAOT,aAAP;AACH;;ACrBM,SAASU,kBAAT,CAA4Bb,GAA5B,EAAiCc,UAAjC,EAA6C;AAChD,QAAMC,SAAS,GAAG,KAAKC,IAAL,CAAUhB,GAAV,IAAiB,GAAjB,GAAuB,GAAzC;AACA,QAAMiB,KAAK,GAAGjC,MAAM,CAACC,IAAP,CAAY6B,UAAZ,CAAd;;AACA,MAAIG,KAAK,CAACX,MAAN,KAAiB,CAArB,EAAwB;AACpB,WAAON,GAAP;AACH;;AACD,SAAQA,GAAG,GACPe,SADI,GAEJE,KAAK,CACAN,GADL,CACUO,IAAD,IAAU;AACf,QAAIA,IAAI,KAAK,GAAb,EAAkB;AACd,aAAQ,OAAOJ,UAAU,CAACK,CAAX,CAAalB,KAAb,CAAmB,GAAnB,EAAwBU,GAAxB,CAA4BS,kBAA5B,EAAgDC,IAAhD,CAAqD,GAArD,CAAf;AACH;;AACD,WAAQ,GAAEH,IAAK,IAAGE,kBAAkB,CAACN,UAAU,CAACI,IAAD,CAAX,CAAmB,EAAvD;AACH,GAND,EAOKG,IAPL,CAOU,GAPV,CAFJ;AAUH;;AChBD,MAAMC,gBAAgB,GAAG,YAAzB;;AACA,SAASC,cAAT,CAAwBC,YAAxB,EAAsC;AAClC,SAAOA,YAAY,CAACZ,OAAb,CAAqB,YAArB,EAAmC,EAAnC,EAAuCX,KAAvC,CAA6C,GAA7C,CAAP;AACH;;AACD,AAAO,SAASwB,uBAAT,CAAiCzB,GAAjC,EAAsC;AACzC,QAAM0B,OAAO,GAAG1B,GAAG,CAAC2B,KAAJ,CAAUL,gBAAV,CAAhB;;AACA,MAAI,CAACI,OAAL,EAAc;AACV,WAAO,EAAP;AACH;;AACD,SAAOA,OAAO,CAACf,GAAR,CAAYY,cAAZ,EAA4BrC,MAA5B,CAAmC,CAAC0C,CAAD,EAAIC,CAAJ,KAAUD,CAAC,CAAClB,MAAF,CAASmB,CAAT,CAA7C,EAA0D,EAA1D,CAAP;AACH;;ACVM,SAASC,IAAT,CAAc/C,MAAd,EAAsBgD,UAAtB,EAAkC;AACrC,SAAO/C,MAAM,CAACC,IAAP,CAAYF,MAAZ,EACFwB,MADE,CACMyB,MAAD,IAAY,CAACD,UAAU,CAACtB,QAAX,CAAoBuB,MAApB,CADlB,EAEF9C,MAFE,CAEK,CAAC+C,GAAD,EAAM7C,GAAN,KAAc;AACtB6C,IAAAA,GAAG,CAAC7C,GAAD,CAAH,GAAWL,MAAM,CAACK,GAAD,CAAjB;AACA,WAAO6C,GAAP;AACH,GALM,EAKJ,EALI,CAAP;AAMH;;ACPD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AACA;AACA,SAASC,cAAT,CAAwBC,GAAxB,EAA6B;AACzB,SAAOA,GAAG,CACLlC,KADE,CACI,oBADJ,EAEFU,GAFE,CAEE,UAAUyB,IAAV,EAAgB;AACrB,QAAI,CAAC,eAAepB,IAAf,CAAoBoB,IAApB,CAAL,EAAgC;AAC5BA,MAAAA,IAAI,GAAGC,SAAS,CAACD,IAAD,CAAT,CAAgBxB,OAAhB,CAAwB,MAAxB,EAAgC,GAAhC,EAAqCA,OAArC,CAA6C,MAA7C,EAAqD,GAArD,CAAP;AACH;;AACD,WAAOwB,IAAP;AACH,GAPM,EAQFf,IARE,CAQG,EARH,CAAP;AASH;;AACD,SAASiB,gBAAT,CAA0BH,GAA1B,EAA+B;AAC3B,SAAOf,kBAAkB,CAACe,GAAD,CAAlB,CAAwBvB,OAAxB,CAAgC,UAAhC,EAA4C,UAAU2B,CAAV,EAAa;AAC5D,WAAO,MAAMA,CAAC,CAACC,UAAF,CAAa,CAAb,EAAgBC,QAAhB,CAAyB,EAAzB,EAA6BC,WAA7B,EAAb;AACH,GAFM,CAAP;AAGH;;AACD,SAASC,WAAT,CAAqBC,QAArB,EAA+BC,KAA/B,EAAsCzD,GAAtC,EAA2C;AACvCyD,EAAAA,KAAK,GACDD,QAAQ,KAAK,GAAb,IAAoBA,QAAQ,KAAK,GAAjC,GACMV,cAAc,CAACW,KAAD,CADpB,GAEMP,gBAAgB,CAACO,KAAD,CAH1B;;AAIA,MAAIzD,GAAJ,EAAS;AACL,WAAOkD,gBAAgB,CAAClD,GAAD,CAAhB,GAAwB,GAAxB,GAA8ByD,KAArC;AACH,GAFD,MAGK;AACD,WAAOA,KAAP;AACH;AACJ;;AACD,SAASC,SAAT,CAAmBD,KAAnB,EAA0B;AACtB,SAAOA,KAAK,KAAKE,SAAV,IAAuBF,KAAK,KAAK,IAAxC;AACH;;AACD,SAASG,aAAT,CAAuBJ,QAAvB,EAAiC;AAC7B,SAAOA,QAAQ,KAAK,GAAb,IAAoBA,QAAQ,KAAK,GAAjC,IAAwCA,QAAQ,KAAK,GAA5D;AACH;;AACD,SAASK,SAAT,CAAmBC,OAAnB,EAA4BN,QAA5B,EAAsCxD,GAAtC,EAA2C+D,QAA3C,EAAqD;AACjD,MAAIN,KAAK,GAAGK,OAAO,CAAC9D,GAAD,CAAnB;AAAA,MAA0BK,MAAM,GAAG,EAAnC;;AACA,MAAIqD,SAAS,CAACD,KAAD,CAAT,IAAoBA,KAAK,KAAK,EAAlC,EAAsC;AAClC,QAAI,OAAOA,KAAP,KAAiB,QAAjB,IACA,OAAOA,KAAP,KAAiB,QADjB,IAEA,OAAOA,KAAP,KAAiB,SAFrB,EAEgC;AAC5BA,MAAAA,KAAK,GAAGA,KAAK,CAACJ,QAAN,EAAR;;AACA,UAAIU,QAAQ,IAAIA,QAAQ,KAAK,GAA7B,EAAkC;AAC9BN,QAAAA,KAAK,GAAGA,KAAK,CAACO,SAAN,CAAgB,CAAhB,EAAmBC,QAAQ,CAACF,QAAD,EAAW,EAAX,CAA3B,CAAR;AACH;;AACD1D,MAAAA,MAAM,CAAC6D,IAAP,CAAYX,WAAW,CAACC,QAAD,EAAWC,KAAX,EAAkBG,aAAa,CAACJ,QAAD,CAAb,GAA0BxD,GAA1B,GAAgC,EAAlD,CAAvB;AACH,KARD,MASK;AACD,UAAI+D,QAAQ,KAAK,GAAjB,EAAsB;AAClB,YAAII,KAAK,CAACC,OAAN,CAAcX,KAAd,CAAJ,EAA0B;AACtBA,UAAAA,KAAK,CAACtC,MAAN,CAAauC,SAAb,EAAwBnD,OAAxB,CAAgC,UAAUkD,KAAV,EAAiB;AAC7CpD,YAAAA,MAAM,CAAC6D,IAAP,CAAYX,WAAW,CAACC,QAAD,EAAWC,KAAX,EAAkBG,aAAa,CAACJ,QAAD,CAAb,GAA0BxD,GAA1B,GAAgC,EAAlD,CAAvB;AACH,WAFD;AAGH,SAJD,MAKK;AACDJ,UAAAA,MAAM,CAACC,IAAP,CAAY4D,KAAZ,EAAmBlD,OAAnB,CAA2B,UAAU8D,CAAV,EAAa;AACpC,gBAAIX,SAAS,CAACD,KAAK,CAACY,CAAD,CAAN,CAAb,EAAyB;AACrBhE,cAAAA,MAAM,CAAC6D,IAAP,CAAYX,WAAW,CAACC,QAAD,EAAWC,KAAK,CAACY,CAAD,CAAhB,EAAqBA,CAArB,CAAvB;AACH;AACJ,WAJD;AAKH;AACJ,OAbD,MAcK;AACD,cAAMC,GAAG,GAAG,EAAZ;;AACA,YAAIH,KAAK,CAACC,OAAN,CAAcX,KAAd,CAAJ,EAA0B;AACtBA,UAAAA,KAAK,CAACtC,MAAN,CAAauC,SAAb,EAAwBnD,OAAxB,CAAgC,UAAUkD,KAAV,EAAiB;AAC7Ca,YAAAA,GAAG,CAACJ,IAAJ,CAASX,WAAW,CAACC,QAAD,EAAWC,KAAX,CAApB;AACH,WAFD;AAGH,SAJD,MAKK;AACD7D,UAAAA,MAAM,CAACC,IAAP,CAAY4D,KAAZ,EAAmBlD,OAAnB,CAA2B,UAAU8D,CAAV,EAAa;AACpC,gBAAIX,SAAS,CAACD,KAAK,CAACY,CAAD,CAAN,CAAb,EAAyB;AACrBC,cAAAA,GAAG,CAACJ,IAAJ,CAAShB,gBAAgB,CAACmB,CAAD,CAAzB;AACAC,cAAAA,GAAG,CAACJ,IAAJ,CAASX,WAAW,CAACC,QAAD,EAAWC,KAAK,CAACY,CAAD,CAAL,CAAShB,QAAT,EAAX,CAApB;AACH;AACJ,WALD;AAMH;;AACD,YAAIO,aAAa,CAACJ,QAAD,CAAjB,EAA6B;AACzBnD,UAAAA,MAAM,CAAC6D,IAAP,CAAYhB,gBAAgB,CAAClD,GAAD,CAAhB,GAAwB,GAAxB,GAA8BsE,GAAG,CAACrC,IAAJ,CAAS,GAAT,CAA1C;AACH,SAFD,MAGK,IAAIqC,GAAG,CAACpD,MAAJ,KAAe,CAAnB,EAAsB;AACvBb,UAAAA,MAAM,CAAC6D,IAAP,CAAYI,GAAG,CAACrC,IAAJ,CAAS,GAAT,CAAZ;AACH;AACJ;AACJ;AACJ,GAhDD,MAiDK;AACD,QAAIuB,QAAQ,KAAK,GAAjB,EAAsB;AAClB,UAAIE,SAAS,CAACD,KAAD,CAAb,EAAsB;AAClBpD,QAAAA,MAAM,CAAC6D,IAAP,CAAYhB,gBAAgB,CAAClD,GAAD,CAA5B;AACH;AACJ,KAJD,MAKK,IAAIyD,KAAK,KAAK,EAAV,KAAiBD,QAAQ,KAAK,GAAb,IAAoBA,QAAQ,KAAK,GAAlD,CAAJ,EAA4D;AAC7DnD,MAAAA,MAAM,CAAC6D,IAAP,CAAYhB,gBAAgB,CAAClD,GAAD,CAAhB,GAAwB,GAApC;AACH,KAFI,MAGA,IAAIyD,KAAK,KAAK,EAAd,EAAkB;AACnBpD,MAAAA,MAAM,CAAC6D,IAAP,CAAY,EAAZ;AACH;AACJ;;AACD,SAAO7D,MAAP;AACH;;AACD,AAAO,SAASkE,QAAT,CAAkBC,QAAlB,EAA4B;AAC/B,SAAO;AACHC,IAAAA,MAAM,EAAEA,MAAM,CAACC,IAAP,CAAY,IAAZ,EAAkBF,QAAlB;AADL,GAAP;AAGH;;AACD,SAASC,MAAT,CAAgBD,QAAhB,EAA0BV,OAA1B,EAAmC;AAC/B,MAAIa,SAAS,GAAG,CAAC,GAAD,EAAM,GAAN,EAAW,GAAX,EAAgB,GAAhB,EAAqB,GAArB,EAA0B,GAA1B,EAA+B,GAA/B,CAAhB;AACA,SAAOH,QAAQ,CAAChD,OAAT,CAAiB,4BAAjB,EAA+C,UAAUoD,CAAV,EAAaC,UAAb,EAAyBC,OAAzB,EAAkC;AACpF,QAAID,UAAJ,EAAgB;AACZ,UAAIrB,QAAQ,GAAG,EAAf;AACA,YAAMuB,MAAM,GAAG,EAAf;;AACA,UAAIJ,SAAS,CAACK,OAAV,CAAkBH,UAAU,CAACI,MAAX,CAAkB,CAAlB,CAAlB,MAA4C,CAAC,CAAjD,EAAoD;AAChDzB,QAAAA,QAAQ,GAAGqB,UAAU,CAACI,MAAX,CAAkB,CAAlB,CAAX;AACAJ,QAAAA,UAAU,GAAGA,UAAU,CAACK,MAAX,CAAkB,CAAlB,CAAb;AACH;;AACDL,MAAAA,UAAU,CAAChE,KAAX,CAAiB,IAAjB,EAAuBN,OAAvB,CAA+B,UAAU4E,QAAV,EAAoB;AAC/C,YAAIb,GAAG,GAAG,4BAA4Bc,IAA5B,CAAiCD,QAAjC,CAAV;AACAJ,QAAAA,MAAM,CAACb,IAAP,CAAYL,SAAS,CAACC,OAAD,EAAUN,QAAV,EAAoBc,GAAG,CAAC,CAAD,CAAvB,EAA4BA,GAAG,CAAC,CAAD,CAAH,IAAUA,GAAG,CAAC,CAAD,CAAzC,CAArB;AACH,OAHD;;AAIA,UAAId,QAAQ,IAAIA,QAAQ,KAAK,GAA7B,EAAkC;AAC9B,YAAI7B,SAAS,GAAG,GAAhB;;AACA,YAAI6B,QAAQ,KAAK,GAAjB,EAAsB;AAClB7B,UAAAA,SAAS,GAAG,GAAZ;AACH,SAFD,MAGK,IAAI6B,QAAQ,KAAK,GAAjB,EAAsB;AACvB7B,UAAAA,SAAS,GAAG6B,QAAZ;AACH;;AACD,eAAO,CAACuB,MAAM,CAAC7D,MAAP,KAAkB,CAAlB,GAAsBsC,QAAtB,GAAiC,EAAlC,IAAwCuB,MAAM,CAAC9C,IAAP,CAAYN,SAAZ,CAA/C;AACH,OATD,MAUK;AACD,eAAOoD,MAAM,CAAC9C,IAAP,CAAY,GAAZ,CAAP;AACH;AACJ,KAxBD,MAyBK;AACD,aAAOa,cAAc,CAACgC,OAAD,CAArB;AACH;AACJ,GA7BM,CAAP;AA8BH;;AC/JM,SAASO,KAAT,CAAejF,OAAf,EAAwB;AAC3B;AACA,MAAIO,MAAM,GAAGP,OAAO,CAACO,MAAR,CAAe2C,WAAf,EAAb,CAF2B;;AAI3B,MAAI1C,GAAG,GAAG,CAACR,OAAO,CAACQ,GAAR,IAAe,GAAhB,EAAqBY,OAArB,CAA6B,cAA7B,EAA6C,OAA7C,CAAV;AACA,MAAIV,OAAO,GAAGlB,MAAM,CAACU,MAAP,CAAc,EAAd,EAAkBF,OAAO,CAACU,OAA1B,CAAd;AACA,MAAIwE,IAAJ;AACA,MAAI5D,UAAU,GAAGgB,IAAI,CAACtC,OAAD,EAAU,CAC3B,QAD2B,EAE3B,SAF2B,EAG3B,KAH2B,EAI3B,SAJ2B,EAK3B,SAL2B,EAM3B,WAN2B,CAAV,CAArB,CAP2B;;AAgB3B,QAAMmF,gBAAgB,GAAGlD,uBAAuB,CAACzB,GAAD,CAAhD;AACAA,EAAAA,GAAG,GAAG2D,QAAQ,CAAC3D,GAAD,CAAR,CAAc6D,MAAd,CAAqB/C,UAArB,CAAN;;AACA,MAAI,CAAC,QAAQE,IAAR,CAAahB,GAAb,CAAL,EAAwB;AACpBA,IAAAA,GAAG,GAAGR,OAAO,CAACoF,OAAR,GAAkB5E,GAAxB;AACH;;AACD,QAAM6E,iBAAiB,GAAG7F,MAAM,CAACC,IAAP,CAAYO,OAAZ,EACrBe,MADqB,CACbyB,MAAD,IAAY2C,gBAAgB,CAAClE,QAAjB,CAA0BuB,MAA1B,CADE,EAErBtB,MAFqB,CAEd,SAFc,CAA1B;AAGA,QAAMoE,mBAAmB,GAAGhD,IAAI,CAAChB,UAAD,EAAa+D,iBAAb,CAAhC;AACA,QAAME,eAAe,GAAG,6BAA6B/D,IAA7B,CAAkCd,OAAO,CAAC8E,MAA1C,CAAxB;;AACA,MAAI,CAACD,eAAL,EAAsB;AAClB,QAAIvF,OAAO,CAACY,SAAR,CAAkB6E,MAAtB,EAA8B;AAC1B;AACA/E,MAAAA,OAAO,CAAC8E,MAAR,GAAiB9E,OAAO,CAAC8E,MAAR,CACZ/E,KADY,CACN,GADM,EAEZU,GAFY,CAEPH,OAAD,IAAaA,OAAO,CAACI,OAAR,CAAgB,kDAAhB,EAAqE,uBAAsBpB,OAAO,CAACY,SAAR,CAAkB6E,MAAO,EAApH,CAFL,EAGZ5D,IAHY,CAGP,GAHO,CAAjB;AAIH;;AACD,QAAI7B,OAAO,CAACY,SAAR,CAAkBC,QAAlB,CAA2BC,MAA/B,EAAuC;AACnC,YAAM4E,wBAAwB,GAAGhF,OAAO,CAAC8E,MAAR,CAAerD,KAAf,CAAqB,qBAArB,KAA+C,EAAhF;AACAzB,MAAAA,OAAO,CAAC8E,MAAR,GAAiBE,wBAAwB,CACpCxE,MADY,CACLlB,OAAO,CAACY,SAAR,CAAkBC,QADb,EAEZM,GAFY,CAEPH,OAAD,IAAa;AAClB,cAAMyE,MAAM,GAAGzF,OAAO,CAACY,SAAR,CAAkB6E,MAAlB,GACR,IAAGzF,OAAO,CAACY,SAAR,CAAkB6E,MAAO,EADpB,GAET,OAFN;AAGA,eAAQ,0BAAyBzE,OAAQ,WAAUyE,MAAO,EAA1D;AACH,OAPgB,EAQZ5D,IARY,CAQP,GARO,CAAjB;AASH;AACJ,GA9C0B;AAgD3B;;;AACA,MAAI,CAAC,KAAD,EAAQ,MAAR,EAAgBZ,QAAhB,CAAyBV,MAAzB,CAAJ,EAAsC;AAClCC,IAAAA,GAAG,GAAGa,kBAAkB,CAACb,GAAD,EAAM8E,mBAAN,CAAxB;AACH,GAFD,MAGK;AACD,QAAI,UAAUA,mBAAd,EAAmC;AAC/BJ,MAAAA,IAAI,GAAGI,mBAAmB,CAACK,IAA3B;AACH,KAFD,MAGK;AACD,UAAInG,MAAM,CAACC,IAAP,CAAY6F,mBAAZ,EAAiCxE,MAArC,EAA6C;AACzCoE,QAAAA,IAAI,GAAGI,mBAAP;AACH,OAFD,MAGK;AACD5E,QAAAA,OAAO,CAAC,gBAAD,CAAP,GAA4B,CAA5B;AACH;AACJ;AACJ,GAhE0B;;;AAkE3B,MAAI,CAACA,OAAO,CAAC,cAAD,CAAR,IAA4B,OAAOwE,IAAP,KAAgB,WAAhD,EAA6D;AACzDxE,IAAAA,OAAO,CAAC,cAAD,CAAP,GAA0B,iCAA1B;AACH,GApE0B;AAsE3B;;;AACA,MAAI,CAAC,OAAD,EAAU,KAAV,EAAiBO,QAAjB,CAA0BV,MAA1B,KAAqC,OAAO2E,IAAP,KAAgB,WAAzD,EAAsE;AAClEA,IAAAA,IAAI,GAAG,EAAP;AACH,GAzE0B;;;AA2E3B,SAAO1F,MAAM,CAACU,MAAP,CAAc;AAAEK,IAAAA,MAAF;AAAUC,IAAAA,GAAV;AAAeE,IAAAA;AAAf,GAAd,EAAwC,OAAOwE,IAAP,KAAgB,WAAhB,GAA8B;AAAEA,IAAAA;AAAF,GAA9B,GAAyC,IAAjF,EAAuFlF,OAAO,CAAC4F,OAAR,GAAkB;AAAEA,IAAAA,OAAO,EAAE5F,OAAO,CAAC4F;AAAnB,GAAlB,GAAiD,IAAxI,CAAP;AACH;;AC9EM,SAASC,oBAAT,CAA8B9F,QAA9B,EAAwCO,KAAxC,EAA+CN,OAA/C,EAAwD;AAC3D,SAAOiF,KAAK,CAAC5E,KAAK,CAACN,QAAD,EAAWO,KAAX,EAAkBN,OAAlB,CAAN,CAAZ;AACH;;ACDM,SAAS8F,YAAT,CAAsBC,WAAtB,EAAmCC,WAAnC,EAAgD;AACnD,QAAMC,QAAQ,GAAG5F,KAAK,CAAC0F,WAAD,EAAcC,WAAd,CAAtB;AACA,QAAME,QAAQ,GAAGL,oBAAoB,CAACvB,IAArB,CAA0B,IAA1B,EAAgC2B,QAAhC,CAAjB;AACA,SAAOzG,MAAM,CAACU,MAAP,CAAcgG,QAAd,EAAwB;AAC3BD,IAAAA,QAD2B;AAE3BlG,IAAAA,QAAQ,EAAE+F,YAAY,CAACxB,IAAb,CAAkB,IAAlB,EAAwB2B,QAAxB,CAFiB;AAG3B5F,IAAAA,KAAK,EAAEA,KAAK,CAACiE,IAAN,CAAW,IAAX,EAAiB2B,QAAjB,CAHoB;AAI3BhB,IAAAA;AAJ2B,GAAxB,CAAP;AAMH;;ACZM,MAAMkB,OAAO,GAAG,mBAAhB;;ACEP,MAAMC,SAAS,GAAI,uBAAsBD,OAAQ,IAAGE,+BAAY,EAAG,EAAnE;AAEA;;AACA,AAAO,MAAMJ,QAAQ,GAAG;AACpB1F,EAAAA,MAAM,EAAE,KADY;AAEpB6E,EAAAA,OAAO,EAAE,wBAFW;AAGpB1E,EAAAA,OAAO,EAAE;AACL8E,IAAAA,MAAM,EAAE,gCADH;AAEL,kBAAcY;AAFT,GAHW;AAOpBxF,EAAAA,SAAS,EAAE;AACP6E,IAAAA,MAAM,EAAE,EADD;AAEP5E,IAAAA,QAAQ,EAAE;AAFH;AAPS,CAAjB;;MCHMqF,QAAQ,GAAGJ,YAAY,CAAC,IAAD,EAAOG,QAAP,CAA7B;;;;"} \ No newline at end of file diff --git a/node_modules/@octokit/endpoint/dist-src/defaults.js b/node_modules/@octokit/endpoint/dist-src/defaults.js index e1e53fb..456e586 100644 --- a/node_modules/@octokit/endpoint/dist-src/defaults.js +++ b/node_modules/@octokit/endpoint/dist-src/defaults.js @@ -8,10 +8,10 @@ export const DEFAULTS = { baseUrl: "https://api.github.com", headers: { accept: "application/vnd.github.v3+json", - "user-agent": userAgent + "user-agent": userAgent, }, mediaType: { format: "", - previews: [] - } + previews: [], + }, }; diff --git a/node_modules/@octokit/endpoint/dist-src/merge.js b/node_modules/@octokit/endpoint/dist-src/merge.js index a209ffa..d79ae65 100644 --- a/node_modules/@octokit/endpoint/dist-src/merge.js +++ b/node_modules/@octokit/endpoint/dist-src/merge.js @@ -14,7 +14,7 @@ export function merge(defaults, route, options) { // mediaType.previews arrays are merged, instead of overwritten if (defaults && defaults.mediaType.previews.length) { mergedOptions.mediaType.previews = defaults.mediaType.previews - .filter(preview => !mergedOptions.mediaType.previews.includes(preview)) + .filter((preview) => !mergedOptions.mediaType.previews.includes(preview)) .concat(mergedOptions.mediaType.previews); } mergedOptions.mediaType.previews = mergedOptions.mediaType.previews.map((preview) => preview.replace(/-preview/, "")); diff --git a/node_modules/@octokit/endpoint/dist-src/parse.js b/node_modules/@octokit/endpoint/dist-src/parse.js index ca68ca9..91197c8 100644 --- a/node_modules/@octokit/endpoint/dist-src/parse.js +++ b/node_modules/@octokit/endpoint/dist-src/parse.js @@ -15,7 +15,7 @@ export function parse(options) { "url", "headers", "request", - "mediaType" + "mediaType", ]); // extract variable names from URL to calculate remaining variables later const urlVariableNames = extractUrlVariableNames(url); @@ -24,7 +24,7 @@ export function parse(options) { url = options.baseUrl + url; } const omittedParameters = Object.keys(options) - .filter(option => urlVariableNames.includes(option)) + .filter((option) => urlVariableNames.includes(option)) .concat("baseUrl"); const remainingParameters = omit(parameters, omittedParameters); const isBinaryRequset = /application\/octet-stream/i.test(headers.accept); @@ -33,14 +33,14 @@ export function parse(options) { // e.g. application/vnd.github.v3+json => application/vnd.github.v3.raw headers.accept = headers.accept .split(/,/) - .map(preview => preview.replace(/application\/vnd(\.\w+)(\.v3)?(\.\w+)?(\+json)?$/, `application/vnd$1$2.${options.mediaType.format}`)) + .map((preview) => preview.replace(/application\/vnd(\.\w+)(\.v3)?(\.\w+)?(\+json)?$/, `application/vnd$1$2.${options.mediaType.format}`)) .join(","); } if (options.mediaType.previews.length) { const previewsFromAcceptHeader = headers.accept.match(/[\w-]+(?=-preview)/g) || []; headers.accept = previewsFromAcceptHeader .concat(options.mediaType.previews) - .map(preview => { + .map((preview) => { const format = options.mediaType.format ? `.${options.mediaType.format}` : "+json"; diff --git a/node_modules/@octokit/endpoint/dist-src/util/add-query-parameters.js b/node_modules/@octokit/endpoint/dist-src/util/add-query-parameters.js index a78812f..d26be31 100644 --- a/node_modules/@octokit/endpoint/dist-src/util/add-query-parameters.js +++ b/node_modules/@octokit/endpoint/dist-src/util/add-query-parameters.js @@ -7,13 +7,9 @@ export function addQueryParameters(url, parameters) { return (url + separator + names - .map(name => { + .map((name) => { if (name === "q") { - return ("q=" + - parameters - .q.split("+") - .map(encodeURIComponent) - .join("+")); + return ("q=" + parameters.q.split("+").map(encodeURIComponent).join("+")); } return `${name}=${encodeURIComponent(parameters[name])}`; }) diff --git a/node_modules/@octokit/endpoint/dist-src/util/merge-deep.js b/node_modules/@octokit/endpoint/dist-src/util/merge-deep.js index d1c5402..eca9a72 100644 --- a/node_modules/@octokit/endpoint/dist-src/util/merge-deep.js +++ b/node_modules/@octokit/endpoint/dist-src/util/merge-deep.js @@ -1,7 +1,7 @@ import isPlainObject from "is-plain-object"; export function mergeDeep(defaults, options) { const result = Object.assign({}, defaults); - Object.keys(options).forEach(key => { + Object.keys(options).forEach((key) => { if (isPlainObject(options[key])) { if (!(key in defaults)) Object.assign(result, { [key]: options[key] }); diff --git a/node_modules/@octokit/endpoint/dist-src/util/omit.js b/node_modules/@octokit/endpoint/dist-src/util/omit.js index 7e1aa6b..6245031 100644 --- a/node_modules/@octokit/endpoint/dist-src/util/omit.js +++ b/node_modules/@octokit/endpoint/dist-src/util/omit.js @@ -1,6 +1,6 @@ export function omit(object, keysToOmit) { return Object.keys(object) - .filter(option => !keysToOmit.includes(option)) + .filter((option) => !keysToOmit.includes(option)) .reduce((obj, key) => { obj[key] = object[key]; return obj; diff --git a/node_modules/@octokit/endpoint/dist-src/util/url-template.js b/node_modules/@octokit/endpoint/dist-src/util/url-template.js index f6d9885..439b3fe 100644 --- a/node_modules/@octokit/endpoint/dist-src/util/url-template.js +++ b/node_modules/@octokit/endpoint/dist-src/util/url-template.js @@ -29,9 +29,7 @@ function encodeReserved(str) { .split(/(%[0-9A-Fa-f]{2})/g) .map(function (part) { if (!/%[0-9A-Fa-f]/.test(part)) { - part = encodeURI(part) - .replace(/%5B/g, "[") - .replace(/%5D/g, "]"); + part = encodeURI(part).replace(/%5B/g, "[").replace(/%5D/g, "]"); } return part; }) @@ -39,11 +37,7 @@ function encodeReserved(str) { } function encodeUnreserved(str) { return encodeURIComponent(str).replace(/[!'()*]/g, function (c) { - return ("%" + - c - .charCodeAt(0) - .toString(16) - .toUpperCase()); + return "%" + c.charCodeAt(0).toString(16).toUpperCase(); }); } function encodeValue(operator, value, key) { @@ -132,7 +126,7 @@ function getValues(context, operator, key, modifier) { } export function parseUrl(template) { return { - expand: expand.bind(null, template) + expand: expand.bind(null, template), }; } function expand(template, context) { diff --git a/node_modules/@octokit/endpoint/dist-src/version.js b/node_modules/@octokit/endpoint/dist-src/version.js index ef91397..32adcce 100644 --- a/node_modules/@octokit/endpoint/dist-src/version.js +++ b/node_modules/@octokit/endpoint/dist-src/version.js @@ -1 +1 @@ -export const VERSION = "5.5.1"; +export const VERSION = "6.0.1"; diff --git a/node_modules/@octokit/endpoint/dist-src/with-defaults.js b/node_modules/@octokit/endpoint/dist-src/with-defaults.js index 9a1c886..81baf6c 100644 --- a/node_modules/@octokit/endpoint/dist-src/with-defaults.js +++ b/node_modules/@octokit/endpoint/dist-src/with-defaults.js @@ -8,6 +8,6 @@ export function withDefaults(oldDefaults, newDefaults) { DEFAULTS, defaults: withDefaults.bind(null, DEFAULTS), merge: merge.bind(null, DEFAULTS), - parse + parse, }); } diff --git a/node_modules/@octokit/endpoint/dist-types/index.d.ts b/node_modules/@octokit/endpoint/dist-types/index.d.ts index 17be855..1ede136 100644 --- a/node_modules/@octokit/endpoint/dist-types/index.d.ts +++ b/node_modules/@octokit/endpoint/dist-types/index.d.ts @@ -1 +1 @@ -export declare const endpoint: import("@octokit/types").EndpointInterface; +export declare const endpoint: import("@octokit/types").EndpointInterface; diff --git a/node_modules/@octokit/endpoint/dist-types/version.d.ts b/node_modules/@octokit/endpoint/dist-types/version.d.ts index 809d28a..c9bca57 100644 --- a/node_modules/@octokit/endpoint/dist-types/version.d.ts +++ b/node_modules/@octokit/endpoint/dist-types/version.d.ts @@ -1 +1 @@ -export declare const VERSION = "5.5.1"; +export declare const VERSION = "6.0.1"; diff --git a/node_modules/@octokit/endpoint/dist-web/index.js b/node_modules/@octokit/endpoint/dist-web/index.js index a327238..534aeca 100644 --- a/node_modules/@octokit/endpoint/dist-web/index.js +++ b/node_modules/@octokit/endpoint/dist-web/index.js @@ -13,7 +13,7 @@ function lowercaseKeys(object) { function mergeDeep(defaults, options) { const result = Object.assign({}, defaults); - Object.keys(options).forEach(key => { + Object.keys(options).forEach((key) => { if (isPlainObject(options[key])) { if (!(key in defaults)) Object.assign(result, { [key]: options[key] }); @@ -41,7 +41,7 @@ function merge(defaults, route, options) { // mediaType.previews arrays are merged, instead of overwritten if (defaults && defaults.mediaType.previews.length) { mergedOptions.mediaType.previews = defaults.mediaType.previews - .filter(preview => !mergedOptions.mediaType.previews.includes(preview)) + .filter((preview) => !mergedOptions.mediaType.previews.includes(preview)) .concat(mergedOptions.mediaType.previews); } mergedOptions.mediaType.previews = mergedOptions.mediaType.previews.map((preview) => preview.replace(/-preview/, "")); @@ -57,13 +57,9 @@ function addQueryParameters(url, parameters) { return (url + separator + names - .map(name => { + .map((name) => { if (name === "q") { - return ("q=" + - parameters - .q.split("+") - .map(encodeURIComponent) - .join("+")); + return ("q=" + parameters.q.split("+").map(encodeURIComponent).join("+")); } return `${name}=${encodeURIComponent(parameters[name])}`; }) @@ -84,7 +80,7 @@ function extractUrlVariableNames(url) { function omit(object, keysToOmit) { return Object.keys(object) - .filter(option => !keysToOmit.includes(option)) + .filter((option) => !keysToOmit.includes(option)) .reduce((obj, key) => { obj[key] = object[key]; return obj; @@ -122,9 +118,7 @@ function encodeReserved(str) { .split(/(%[0-9A-Fa-f]{2})/g) .map(function (part) { if (!/%[0-9A-Fa-f]/.test(part)) { - part = encodeURI(part) - .replace(/%5B/g, "[") - .replace(/%5D/g, "]"); + part = encodeURI(part).replace(/%5B/g, "[").replace(/%5D/g, "]"); } return part; }) @@ -132,11 +126,7 @@ function encodeReserved(str) { } function encodeUnreserved(str) { return encodeURIComponent(str).replace(/[!'()*]/g, function (c) { - return ("%" + - c - .charCodeAt(0) - .toString(16) - .toUpperCase()); + return "%" + c.charCodeAt(0).toString(16).toUpperCase(); }); } function encodeValue(operator, value, key) { @@ -225,7 +215,7 @@ function getValues(context, operator, key, modifier) { } function parseUrl(template) { return { - expand: expand.bind(null, template) + expand: expand.bind(null, template), }; } function expand(template, context) { @@ -275,7 +265,7 @@ function parse(options) { "url", "headers", "request", - "mediaType" + "mediaType", ]); // extract variable names from URL to calculate remaining variables later const urlVariableNames = extractUrlVariableNames(url); @@ -284,7 +274,7 @@ function parse(options) { url = options.baseUrl + url; } const omittedParameters = Object.keys(options) - .filter(option => urlVariableNames.includes(option)) + .filter((option) => urlVariableNames.includes(option)) .concat("baseUrl"); const remainingParameters = omit(parameters, omittedParameters); const isBinaryRequset = /application\/octet-stream/i.test(headers.accept); @@ -293,14 +283,14 @@ function parse(options) { // e.g. application/vnd.github.v3+json => application/vnd.github.v3.raw headers.accept = headers.accept .split(/,/) - .map(preview => preview.replace(/application\/vnd(\.\w+)(\.v3)?(\.\w+)?(\+json)?$/, `application/vnd$1$2.${options.mediaType.format}`)) + .map((preview) => preview.replace(/application\/vnd(\.\w+)(\.v3)?(\.\w+)?(\+json)?$/, `application/vnd$1$2.${options.mediaType.format}`)) .join(","); } if (options.mediaType.previews.length) { const previewsFromAcceptHeader = headers.accept.match(/[\w-]+(?=-preview)/g) || []; headers.accept = previewsFromAcceptHeader .concat(options.mediaType.previews) - .map(preview => { + .map((preview) => { const format = options.mediaType.format ? `.${options.mediaType.format}` : "+json"; @@ -351,11 +341,11 @@ function withDefaults(oldDefaults, newDefaults) { DEFAULTS, defaults: withDefaults.bind(null, DEFAULTS), merge: merge.bind(null, DEFAULTS), - parse + parse, }); } -const VERSION = "5.5.1"; +const VERSION = "6.0.1"; const userAgent = `octokit-endpoint.js/${VERSION} ${getUserAgent()}`; // DEFAULTS has all properties set that EndpointOptions has, except url. @@ -365,12 +355,12 @@ const DEFAULTS = { baseUrl: "https://api.github.com", headers: { accept: "application/vnd.github.v3+json", - "user-agent": userAgent + "user-agent": userAgent, }, mediaType: { format: "", - previews: [] - } + previews: [], + }, }; const endpoint = withDefaults(null, DEFAULTS); diff --git a/node_modules/@octokit/endpoint/dist-web/index.js.map b/node_modules/@octokit/endpoint/dist-web/index.js.map index 6890009..6f5b87d 100644 --- a/node_modules/@octokit/endpoint/dist-web/index.js.map +++ b/node_modules/@octokit/endpoint/dist-web/index.js.map @@ -1 +1 @@ -{"version":3,"file":"index.js","sources":["../dist-src/util/lowercase-keys.js","../dist-src/util/merge-deep.js","../dist-src/merge.js","../dist-src/util/add-query-parameters.js","../dist-src/util/extract-url-variable-names.js","../dist-src/util/omit.js","../dist-src/util/url-template.js","../dist-src/parse.js","../dist-src/endpoint-with-defaults.js","../dist-src/with-defaults.js","../dist-src/version.js","../dist-src/defaults.js","../dist-src/index.js"],"sourcesContent":["export function lowercaseKeys(object) {\n if (!object) {\n return {};\n }\n return Object.keys(object).reduce((newObj, key) => {\n newObj[key.toLowerCase()] = object[key];\n return newObj;\n }, {});\n}\n","import isPlainObject from \"is-plain-object\";\nexport function mergeDeep(defaults, options) {\n const result = Object.assign({}, defaults);\n Object.keys(options).forEach(key => {\n if (isPlainObject(options[key])) {\n if (!(key in defaults))\n Object.assign(result, { [key]: options[key] });\n else\n result[key] = mergeDeep(defaults[key], options[key]);\n }\n else {\n Object.assign(result, { [key]: options[key] });\n }\n });\n return result;\n}\n","import { lowercaseKeys } from \"./util/lowercase-keys\";\nimport { mergeDeep } from \"./util/merge-deep\";\nexport function merge(defaults, route, options) {\n if (typeof route === \"string\") {\n let [method, url] = route.split(\" \");\n options = Object.assign(url ? { method, url } : { url: method }, options);\n }\n else {\n options = Object.assign({}, route);\n }\n // lowercase header names before merging with defaults to avoid duplicates\n options.headers = lowercaseKeys(options.headers);\n const mergedOptions = mergeDeep(defaults || {}, options);\n // mediaType.previews arrays are merged, instead of overwritten\n if (defaults && defaults.mediaType.previews.length) {\n mergedOptions.mediaType.previews = defaults.mediaType.previews\n .filter(preview => !mergedOptions.mediaType.previews.includes(preview))\n .concat(mergedOptions.mediaType.previews);\n }\n mergedOptions.mediaType.previews = mergedOptions.mediaType.previews.map((preview) => preview.replace(/-preview/, \"\"));\n return mergedOptions;\n}\n","export function addQueryParameters(url, parameters) {\n const separator = /\\?/.test(url) ? \"&\" : \"?\";\n const names = Object.keys(parameters);\n if (names.length === 0) {\n return url;\n }\n return (url +\n separator +\n names\n .map(name => {\n if (name === \"q\") {\n return (\"q=\" +\n parameters\n .q.split(\"+\")\n .map(encodeURIComponent)\n .join(\"+\"));\n }\n return `${name}=${encodeURIComponent(parameters[name])}`;\n })\n .join(\"&\"));\n}\n","const urlVariableRegex = /\\{[^}]+\\}/g;\nfunction removeNonChars(variableName) {\n return variableName.replace(/^\\W+|\\W+$/g, \"\").split(/,/);\n}\nexport function extractUrlVariableNames(url) {\n const matches = url.match(urlVariableRegex);\n if (!matches) {\n return [];\n }\n return matches.map(removeNonChars).reduce((a, b) => a.concat(b), []);\n}\n","export function omit(object, keysToOmit) {\n return Object.keys(object)\n .filter(option => !keysToOmit.includes(option))\n .reduce((obj, key) => {\n obj[key] = object[key];\n return obj;\n }, {});\n}\n","// Based on https://github.com/bramstein/url-template, licensed under BSD\n// TODO: create separate package.\n//\n// Copyright (c) 2012-2014, Bram Stein\n// All rights reserved.\n// Redistribution and use in source and binary forms, with or without\n// modification, are permitted provided that the following conditions\n// are met:\n// 1. Redistributions of source code must retain the above copyright\n// notice, this list of conditions and the following disclaimer.\n// 2. Redistributions in binary form must reproduce the above copyright\n// notice, this list of conditions and the following disclaimer in the\n// documentation and/or other materials provided with the distribution.\n// 3. The name of the author may not be used to endorse or promote products\n// derived from this software without specific prior written permission.\n// THIS SOFTWARE IS PROVIDED BY THE AUTHOR \"AS IS\" AND ANY EXPRESS OR IMPLIED\n// WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF\n// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO\n// EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,\n// INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,\n// BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,\n// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY\n// OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING\n// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,\n// EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n/* istanbul ignore file */\nfunction encodeReserved(str) {\n return str\n .split(/(%[0-9A-Fa-f]{2})/g)\n .map(function (part) {\n if (!/%[0-9A-Fa-f]/.test(part)) {\n part = encodeURI(part)\n .replace(/%5B/g, \"[\")\n .replace(/%5D/g, \"]\");\n }\n return part;\n })\n .join(\"\");\n}\nfunction encodeUnreserved(str) {\n return encodeURIComponent(str).replace(/[!'()*]/g, function (c) {\n return (\"%\" +\n c\n .charCodeAt(0)\n .toString(16)\n .toUpperCase());\n });\n}\nfunction encodeValue(operator, value, key) {\n value =\n operator === \"+\" || operator === \"#\"\n ? encodeReserved(value)\n : encodeUnreserved(value);\n if (key) {\n return encodeUnreserved(key) + \"=\" + value;\n }\n else {\n return value;\n }\n}\nfunction isDefined(value) {\n return value !== undefined && value !== null;\n}\nfunction isKeyOperator(operator) {\n return operator === \";\" || operator === \"&\" || operator === \"?\";\n}\nfunction getValues(context, operator, key, modifier) {\n var value = context[key], result = [];\n if (isDefined(value) && value !== \"\") {\n if (typeof value === \"string\" ||\n typeof value === \"number\" ||\n typeof value === \"boolean\") {\n value = value.toString();\n if (modifier && modifier !== \"*\") {\n value = value.substring(0, parseInt(modifier, 10));\n }\n result.push(encodeValue(operator, value, isKeyOperator(operator) ? key : \"\"));\n }\n else {\n if (modifier === \"*\") {\n if (Array.isArray(value)) {\n value.filter(isDefined).forEach(function (value) {\n result.push(encodeValue(operator, value, isKeyOperator(operator) ? key : \"\"));\n });\n }\n else {\n Object.keys(value).forEach(function (k) {\n if (isDefined(value[k])) {\n result.push(encodeValue(operator, value[k], k));\n }\n });\n }\n }\n else {\n const tmp = [];\n if (Array.isArray(value)) {\n value.filter(isDefined).forEach(function (value) {\n tmp.push(encodeValue(operator, value));\n });\n }\n else {\n Object.keys(value).forEach(function (k) {\n if (isDefined(value[k])) {\n tmp.push(encodeUnreserved(k));\n tmp.push(encodeValue(operator, value[k].toString()));\n }\n });\n }\n if (isKeyOperator(operator)) {\n result.push(encodeUnreserved(key) + \"=\" + tmp.join(\",\"));\n }\n else if (tmp.length !== 0) {\n result.push(tmp.join(\",\"));\n }\n }\n }\n }\n else {\n if (operator === \";\") {\n if (isDefined(value)) {\n result.push(encodeUnreserved(key));\n }\n }\n else if (value === \"\" && (operator === \"&\" || operator === \"?\")) {\n result.push(encodeUnreserved(key) + \"=\");\n }\n else if (value === \"\") {\n result.push(\"\");\n }\n }\n return result;\n}\nexport function parseUrl(template) {\n return {\n expand: expand.bind(null, template)\n };\n}\nfunction expand(template, context) {\n var operators = [\"+\", \"#\", \".\", \"/\", \";\", \"?\", \"&\"];\n return template.replace(/\\{([^\\{\\}]+)\\}|([^\\{\\}]+)/g, function (_, expression, literal) {\n if (expression) {\n let operator = \"\";\n const values = [];\n if (operators.indexOf(expression.charAt(0)) !== -1) {\n operator = expression.charAt(0);\n expression = expression.substr(1);\n }\n expression.split(/,/g).forEach(function (variable) {\n var tmp = /([^:\\*]*)(?::(\\d+)|(\\*))?/.exec(variable);\n values.push(getValues(context, operator, tmp[1], tmp[2] || tmp[3]));\n });\n if (operator && operator !== \"+\") {\n var separator = \",\";\n if (operator === \"?\") {\n separator = \"&\";\n }\n else if (operator !== \"#\") {\n separator = operator;\n }\n return (values.length !== 0 ? operator : \"\") + values.join(separator);\n }\n else {\n return values.join(\",\");\n }\n }\n else {\n return encodeReserved(literal);\n }\n });\n}\n","import { addQueryParameters } from \"./util/add-query-parameters\";\nimport { extractUrlVariableNames } from \"./util/extract-url-variable-names\";\nimport { omit } from \"./util/omit\";\nimport { parseUrl } from \"./util/url-template\";\nexport function parse(options) {\n // https://fetch.spec.whatwg.org/#methods\n let method = options.method.toUpperCase();\n // replace :varname with {varname} to make it RFC 6570 compatible\n let url = (options.url || \"/\").replace(/:([a-z]\\w+)/g, \"{+$1}\");\n let headers = Object.assign({}, options.headers);\n let body;\n let parameters = omit(options, [\n \"method\",\n \"baseUrl\",\n \"url\",\n \"headers\",\n \"request\",\n \"mediaType\"\n ]);\n // extract variable names from URL to calculate remaining variables later\n const urlVariableNames = extractUrlVariableNames(url);\n url = parseUrl(url).expand(parameters);\n if (!/^http/.test(url)) {\n url = options.baseUrl + url;\n }\n const omittedParameters = Object.keys(options)\n .filter(option => urlVariableNames.includes(option))\n .concat(\"baseUrl\");\n const remainingParameters = omit(parameters, omittedParameters);\n const isBinaryRequset = /application\\/octet-stream/i.test(headers.accept);\n if (!isBinaryRequset) {\n if (options.mediaType.format) {\n // e.g. application/vnd.github.v3+json => application/vnd.github.v3.raw\n headers.accept = headers.accept\n .split(/,/)\n .map(preview => preview.replace(/application\\/vnd(\\.\\w+)(\\.v3)?(\\.\\w+)?(\\+json)?$/, `application/vnd$1$2.${options.mediaType.format}`))\n .join(\",\");\n }\n if (options.mediaType.previews.length) {\n const previewsFromAcceptHeader = headers.accept.match(/[\\w-]+(?=-preview)/g) || [];\n headers.accept = previewsFromAcceptHeader\n .concat(options.mediaType.previews)\n .map(preview => {\n const format = options.mediaType.format\n ? `.${options.mediaType.format}`\n : \"+json\";\n return `application/vnd.github.${preview}-preview${format}`;\n })\n .join(\",\");\n }\n }\n // for GET/HEAD requests, set URL query parameters from remaining parameters\n // for PATCH/POST/PUT/DELETE requests, set request body from remaining parameters\n if ([\"GET\", \"HEAD\"].includes(method)) {\n url = addQueryParameters(url, remainingParameters);\n }\n else {\n if (\"data\" in remainingParameters) {\n body = remainingParameters.data;\n }\n else {\n if (Object.keys(remainingParameters).length) {\n body = remainingParameters;\n }\n else {\n headers[\"content-length\"] = 0;\n }\n }\n }\n // default content-type for JSON if body is set\n if (!headers[\"content-type\"] && typeof body !== \"undefined\") {\n headers[\"content-type\"] = \"application/json; charset=utf-8\";\n }\n // GitHub expects 'content-length: 0' header for PUT/PATCH requests without body.\n // fetch does not allow to set `content-length` header, but we can set body to an empty string\n if ([\"PATCH\", \"PUT\"].includes(method) && typeof body === \"undefined\") {\n body = \"\";\n }\n // Only return body/request keys if present\n return Object.assign({ method, url, headers }, typeof body !== \"undefined\" ? { body } : null, options.request ? { request: options.request } : null);\n}\n","import { merge } from \"./merge\";\nimport { parse } from \"./parse\";\nexport function endpointWithDefaults(defaults, route, options) {\n return parse(merge(defaults, route, options));\n}\n","import { endpointWithDefaults } from \"./endpoint-with-defaults\";\nimport { merge } from \"./merge\";\nimport { parse } from \"./parse\";\nexport function withDefaults(oldDefaults, newDefaults) {\n const DEFAULTS = merge(oldDefaults, newDefaults);\n const endpoint = endpointWithDefaults.bind(null, DEFAULTS);\n return Object.assign(endpoint, {\n DEFAULTS,\n defaults: withDefaults.bind(null, DEFAULTS),\n merge: merge.bind(null, DEFAULTS),\n parse\n });\n}\n","export const VERSION = \"5.5.1\";\n","import { getUserAgent } from \"universal-user-agent\";\nimport { VERSION } from \"./version\";\nconst userAgent = `octokit-endpoint.js/${VERSION} ${getUserAgent()}`;\n// DEFAULTS has all properties set that EndpointOptions has, except url.\n// So we use RequestParameters and add method as additional required property.\nexport const DEFAULTS = {\n method: \"GET\",\n baseUrl: \"https://api.github.com\",\n headers: {\n accept: \"application/vnd.github.v3+json\",\n \"user-agent\": userAgent\n },\n mediaType: {\n format: \"\",\n previews: []\n }\n};\n","import { withDefaults } from \"./with-defaults\";\nimport { DEFAULTS } from \"./defaults\";\nexport const endpoint = withDefaults(null, DEFAULTS);\n"],"names":[],"mappings":";;;AAAO,SAAS,aAAa,CAAC,MAAM,EAAE;IAClC,IAAI,CAAC,MAAM,EAAE;QACT,OAAO,EAAE,CAAC;KACb;IACD,OAAO,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,GAAG,KAAK;QAC/C,MAAM,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;QACxC,OAAO,MAAM,CAAC;KACjB,EAAE,EAAE,CAAC,CAAC;CACV;;ACPM,SAAS,SAAS,CAAC,QAAQ,EAAE,OAAO,EAAE;IACzC,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAC;IAC3C,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,GAAG,IAAI;QAChC,IAAI,aAAa,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE;YAC7B,IAAI,EAAE,GAAG,IAAI,QAAQ,CAAC;gBAClB,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;;gBAE/C,MAAM,CAAC,GAAG,CAAC,GAAG,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;SAC5D;aACI;YACD,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;SAClD;KACJ,CAAC,CAAC;IACH,OAAO,MAAM,CAAC;CACjB;;ACbM,SAAS,KAAK,CAAC,QAAQ,EAAE,KAAK,EAAE,OAAO,EAAE;IAC5C,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;QAC3B,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACrC,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,GAAG,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;KAC7E;SACI;QACD,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;KACtC;;IAED,OAAO,CAAC,OAAO,GAAG,aAAa,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IACjD,MAAM,aAAa,GAAG,SAAS,CAAC,QAAQ,IAAI,EAAE,EAAE,OAAO,CAAC,CAAC;;IAEzD,IAAI,QAAQ,IAAI,QAAQ,CAAC,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE;QAChD,aAAa,CAAC,SAAS,CAAC,QAAQ,GAAG,QAAQ,CAAC,SAAS,CAAC,QAAQ;aACzD,MAAM,CAAC,OAAO,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;aACtE,MAAM,CAAC,aAAa,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;KACjD;IACD,aAAa,CAAC,SAAS,CAAC,QAAQ,GAAG,aAAa,CAAC,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,KAAK,OAAO,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC,CAAC;IACtH,OAAO,aAAa,CAAC;CACxB;;ACrBM,SAAS,kBAAkB,CAAC,GAAG,EAAE,UAAU,EAAE;IAChD,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,GAAG,GAAG,GAAG,CAAC;IAC7C,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IACtC,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE;QACpB,OAAO,GAAG,CAAC;KACd;IACD,QAAQ,GAAG;QACP,SAAS;QACT,KAAK;aACA,GAAG,CAAC,IAAI,IAAI;YACb,IAAI,IAAI,KAAK,GAAG,EAAE;gBACd,QAAQ,IAAI;oBACR,UAAU;yBACL,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC;yBACZ,GAAG,CAAC,kBAAkB,CAAC;yBACvB,IAAI,CAAC,GAAG,CAAC,EAAE;aACvB;YACD,OAAO,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,kBAAkB,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;SAC5D,CAAC;aACG,IAAI,CAAC,GAAG,CAAC,EAAE;CACvB;;ACpBD,MAAM,gBAAgB,GAAG,YAAY,CAAC;AACtC,SAAS,cAAc,CAAC,YAAY,EAAE;IAClC,OAAO,YAAY,CAAC,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;CAC5D;AACD,AAAO,SAAS,uBAAuB,CAAC,GAAG,EAAE;IACzC,MAAM,OAAO,GAAG,GAAG,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;IAC5C,IAAI,CAAC,OAAO,EAAE;QACV,OAAO,EAAE,CAAC;KACb;IACD,OAAO,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;CACxE;;ACVM,SAAS,IAAI,CAAC,MAAM,EAAE,UAAU,EAAE;IACrC,OAAO,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC;SACrB,MAAM,CAAC,MAAM,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;SAC9C,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,KAAK;QACtB,GAAG,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;QACvB,OAAO,GAAG,CAAC;KACd,EAAE,EAAE,CAAC,CAAC;CACV;;ACPD;;;;;;;;;;;;;;;;;;;;;;;;;;AA0BA,SAAS,cAAc,CAAC,GAAG,EAAE;IACzB,OAAO,GAAG;SACL,KAAK,CAAC,oBAAoB,CAAC;SAC3B,GAAG,CAAC,UAAU,IAAI,EAAE;QACrB,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;YAC5B,IAAI,GAAG,SAAS,CAAC,IAAI,CAAC;iBACjB,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC;iBACpB,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC;KACf,CAAC;SACG,IAAI,CAAC,EAAE,CAAC,CAAC;CACjB;AACD,SAAS,gBAAgB,CAAC,GAAG,EAAE;IAC3B,OAAO,kBAAkB,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,UAAU,EAAE,UAAU,CAAC,EAAE;QAC5D,QAAQ,GAAG;YACP,CAAC;iBACI,UAAU,CAAC,CAAC,CAAC;iBACb,QAAQ,CAAC,EAAE,CAAC;iBACZ,WAAW,EAAE,EAAE;KAC3B,CAAC,CAAC;CACN;AACD,SAAS,WAAW,CAAC,QAAQ,EAAE,KAAK,EAAE,GAAG,EAAE;IACvC,KAAK;QACD,QAAQ,KAAK,GAAG,IAAI,QAAQ,KAAK,GAAG;cAC9B,cAAc,CAAC,KAAK,CAAC;cACrB,gBAAgB,CAAC,KAAK,CAAC,CAAC;IAClC,IAAI,GAAG,EAAE;QACL,OAAO,gBAAgB,CAAC,GAAG,CAAC,GAAG,GAAG,GAAG,KAAK,CAAC;KAC9C;SACI;QACD,OAAO,KAAK,CAAC;KAChB;CACJ;AACD,SAAS,SAAS,CAAC,KAAK,EAAE;IACtB,OAAO,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,CAAC;CAChD;AACD,SAAS,aAAa,CAAC,QAAQ,EAAE;IAC7B,OAAO,QAAQ,KAAK,GAAG,IAAI,QAAQ,KAAK,GAAG,IAAI,QAAQ,KAAK,GAAG,CAAC;CACnE;AACD,SAAS,SAAS,CAAC,OAAO,EAAE,QAAQ,EAAE,GAAG,EAAE,QAAQ,EAAE;IACjD,IAAI,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,EAAE,MAAM,GAAG,EAAE,CAAC;IACtC,IAAI,SAAS,CAAC,KAAK,CAAC,IAAI,KAAK,KAAK,EAAE,EAAE;QAClC,IAAI,OAAO,KAAK,KAAK,QAAQ;YACzB,OAAO,KAAK,KAAK,QAAQ;YACzB,OAAO,KAAK,KAAK,SAAS,EAAE;YAC5B,KAAK,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAC;YACzB,IAAI,QAAQ,IAAI,QAAQ,KAAK,GAAG,EAAE;gBAC9B,KAAK,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,EAAE,QAAQ,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC;aACtD;YACD,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,KAAK,EAAE,aAAa,CAAC,QAAQ,CAAC,GAAG,GAAG,GAAG,EAAE,CAAC,CAAC,CAAC;SACjF;aACI;YACD,IAAI,QAAQ,KAAK,GAAG,EAAE;gBAClB,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;oBACtB,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,UAAU,KAAK,EAAE;wBAC7C,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,KAAK,EAAE,aAAa,CAAC,QAAQ,CAAC,GAAG,GAAG,GAAG,EAAE,CAAC,CAAC,CAAC;qBACjF,CAAC,CAAC;iBACN;qBACI;oBACD,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE;wBACpC,IAAI,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE;4BACrB,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;yBACnD;qBACJ,CAAC,CAAC;iBACN;aACJ;iBACI;gBACD,MAAM,GAAG,GAAG,EAAE,CAAC;gBACf,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;oBACtB,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,UAAU,KAAK,EAAE;wBAC7C,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC;qBAC1C,CAAC,CAAC;iBACN;qBACI;oBACD,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE;wBACpC,IAAI,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE;4BACrB,GAAG,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC;4BAC9B,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;yBACxD;qBACJ,CAAC,CAAC;iBACN;gBACD,IAAI,aAAa,CAAC,QAAQ,CAAC,EAAE;oBACzB,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,GAAG,GAAG,GAAG,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;iBAC5D;qBACI,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC,EAAE;oBACvB,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;iBAC9B;aACJ;SACJ;KACJ;SACI;QACD,IAAI,QAAQ,KAAK,GAAG,EAAE;YAClB,IAAI,SAAS,CAAC,KAAK,CAAC,EAAE;gBAClB,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,CAAC;aACtC;SACJ;aACI,IAAI,KAAK,KAAK,EAAE,KAAK,QAAQ,KAAK,GAAG,IAAI,QAAQ,KAAK,GAAG,CAAC,EAAE;YAC7D,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,CAAC;SAC5C;aACI,IAAI,KAAK,KAAK,EAAE,EAAE;YACnB,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;SACnB;KACJ;IACD,OAAO,MAAM,CAAC;CACjB;AACD,AAAO,SAAS,QAAQ,CAAC,QAAQ,EAAE;IAC/B,OAAO;QACH,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC;KACtC,CAAC;CACL;AACD,SAAS,MAAM,CAAC,QAAQ,EAAE,OAAO,EAAE;IAC/B,IAAI,SAAS,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;IACpD,OAAO,QAAQ,CAAC,OAAO,CAAC,4BAA4B,EAAE,UAAU,CAAC,EAAE,UAAU,EAAE,OAAO,EAAE;QACpF,IAAI,UAAU,EAAE;YACZ,IAAI,QAAQ,GAAG,EAAE,CAAC;YAClB,MAAM,MAAM,GAAG,EAAE,CAAC;YAClB,IAAI,SAAS,CAAC,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE;gBAChD,QAAQ,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;gBAChC,UAAU,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;aACrC;YACD,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,UAAU,QAAQ,EAAE;gBAC/C,IAAI,GAAG,GAAG,2BAA2B,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;gBACrD,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,QAAQ,EAAE,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;aACvE,CAAC,CAAC;YACH,IAAI,QAAQ,IAAI,QAAQ,KAAK,GAAG,EAAE;gBAC9B,IAAI,SAAS,GAAG,GAAG,CAAC;gBACpB,IAAI,QAAQ,KAAK,GAAG,EAAE;oBAClB,SAAS,GAAG,GAAG,CAAC;iBACnB;qBACI,IAAI,QAAQ,KAAK,GAAG,EAAE;oBACvB,SAAS,GAAG,QAAQ,CAAC;iBACxB;gBACD,OAAO,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,GAAG,QAAQ,GAAG,EAAE,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;aACzE;iBACI;gBACD,OAAO,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;aAC3B;SACJ;aACI;YACD,OAAO,cAAc,CAAC,OAAO,CAAC,CAAC;SAClC;KACJ,CAAC,CAAC;CACN;;ACrKM,SAAS,KAAK,CAAC,OAAO,EAAE;;IAE3B,IAAI,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;;IAE1C,IAAI,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,IAAI,GAAG,EAAE,OAAO,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;IAChE,IAAI,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;IACjD,IAAI,IAAI,CAAC;IACT,IAAI,UAAU,GAAG,IAAI,CAAC,OAAO,EAAE;QAC3B,QAAQ;QACR,SAAS;QACT,KAAK;QACL,SAAS;QACT,SAAS;QACT,WAAW;KACd,CAAC,CAAC;;IAEH,MAAM,gBAAgB,GAAG,uBAAuB,CAAC,GAAG,CAAC,CAAC;IACtD,GAAG,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;IACvC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;QACpB,GAAG,GAAG,OAAO,CAAC,OAAO,GAAG,GAAG,CAAC;KAC/B;IACD,MAAM,iBAAiB,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC;SACzC,MAAM,CAAC,MAAM,IAAI,gBAAgB,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;SACnD,MAAM,CAAC,SAAS,CAAC,CAAC;IACvB,MAAM,mBAAmB,GAAG,IAAI,CAAC,UAAU,EAAE,iBAAiB,CAAC,CAAC;IAChE,MAAM,eAAe,GAAG,4BAA4B,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAC1E,IAAI,CAAC,eAAe,EAAE;QAClB,IAAI,OAAO,CAAC,SAAS,CAAC,MAAM,EAAE;;YAE1B,OAAO,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM;iBAC1B,KAAK,CAAC,GAAG,CAAC;iBACV,GAAG,CAAC,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,kDAAkD,EAAE,CAAC,oBAAoB,EAAE,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;iBACtI,IAAI,CAAC,GAAG,CAAC,CAAC;SAClB;QACD,IAAI,OAAO,CAAC,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE;YACnC,MAAM,wBAAwB,GAAG,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,qBAAqB,CAAC,IAAI,EAAE,CAAC;YACnF,OAAO,CAAC,MAAM,GAAG,wBAAwB;iBACpC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,QAAQ,CAAC;iBAClC,GAAG,CAAC,OAAO,IAAI;gBAChB,MAAM,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC,MAAM;sBACjC,CAAC,CAAC,EAAE,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;sBAC9B,OAAO,CAAC;gBACd,OAAO,CAAC,uBAAuB,EAAE,OAAO,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAC;aAC/D,CAAC;iBACG,IAAI,CAAC,GAAG,CAAC,CAAC;SAClB;KACJ;;;IAGD,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;QAClC,GAAG,GAAG,kBAAkB,CAAC,GAAG,EAAE,mBAAmB,CAAC,CAAC;KACtD;SACI;QACD,IAAI,MAAM,IAAI,mBAAmB,EAAE;YAC/B,IAAI,GAAG,mBAAmB,CAAC,IAAI,CAAC;SACnC;aACI;YACD,IAAI,MAAM,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC,MAAM,EAAE;gBACzC,IAAI,GAAG,mBAAmB,CAAC;aAC9B;iBACI;gBACD,OAAO,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC;aACjC;SACJ;KACJ;;IAED,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,IAAI,OAAO,IAAI,KAAK,WAAW,EAAE;QACzD,OAAO,CAAC,cAAc,CAAC,GAAG,iCAAiC,CAAC;KAC/D;;;IAGD,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,OAAO,IAAI,KAAK,WAAW,EAAE;QAClE,IAAI,GAAG,EAAE,CAAC;KACb;;IAED,OAAO,MAAM,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,EAAE,OAAO,IAAI,KAAK,WAAW,GAAG,EAAE,IAAI,EAAE,GAAG,IAAI,EAAE,OAAO,CAAC,OAAO,GAAG,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,CAAC;CACxJ;;AC9EM,SAAS,oBAAoB,CAAC,QAAQ,EAAE,KAAK,EAAE,OAAO,EAAE;IAC3D,OAAO,KAAK,CAAC,KAAK,CAAC,QAAQ,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC;CACjD;;ACDM,SAAS,YAAY,CAAC,WAAW,EAAE,WAAW,EAAE;IACnD,MAAM,QAAQ,GAAG,KAAK,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;IACjD,MAAM,QAAQ,GAAG,oBAAoB,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IAC3D,OAAO,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE;QAC3B,QAAQ;QACR,QAAQ,EAAE,YAAY,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC;QAC3C,KAAK,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC;QACjC,KAAK;KACR,CAAC,CAAC;CACN;;ACZM,MAAM,OAAO,GAAG,mBAAmB,CAAC;;ACE3C,MAAM,SAAS,GAAG,CAAC,oBAAoB,EAAE,OAAO,CAAC,CAAC,EAAE,YAAY,EAAE,CAAC,CAAC,CAAC;;;AAGrE,AAAO,MAAM,QAAQ,GAAG;IACpB,MAAM,EAAE,KAAK;IACb,OAAO,EAAE,wBAAwB;IACjC,OAAO,EAAE;QACL,MAAM,EAAE,gCAAgC;QACxC,YAAY,EAAE,SAAS;KAC1B;IACD,SAAS,EAAE;QACP,MAAM,EAAE,EAAE;QACV,QAAQ,EAAE,EAAE;KACf;CACJ,CAAC;;ACdU,MAAC,QAAQ,GAAG,YAAY,CAAC,IAAI,EAAE,QAAQ,CAAC;;;;"} \ No newline at end of file +{"version":3,"file":"index.js","sources":["../dist-src/util/lowercase-keys.js","../dist-src/util/merge-deep.js","../dist-src/merge.js","../dist-src/util/add-query-parameters.js","../dist-src/util/extract-url-variable-names.js","../dist-src/util/omit.js","../dist-src/util/url-template.js","../dist-src/parse.js","../dist-src/endpoint-with-defaults.js","../dist-src/with-defaults.js","../dist-src/version.js","../dist-src/defaults.js","../dist-src/index.js"],"sourcesContent":["export function lowercaseKeys(object) {\n if (!object) {\n return {};\n }\n return Object.keys(object).reduce((newObj, key) => {\n newObj[key.toLowerCase()] = object[key];\n return newObj;\n }, {});\n}\n","import isPlainObject from \"is-plain-object\";\nexport function mergeDeep(defaults, options) {\n const result = Object.assign({}, defaults);\n Object.keys(options).forEach((key) => {\n if (isPlainObject(options[key])) {\n if (!(key in defaults))\n Object.assign(result, { [key]: options[key] });\n else\n result[key] = mergeDeep(defaults[key], options[key]);\n }\n else {\n Object.assign(result, { [key]: options[key] });\n }\n });\n return result;\n}\n","import { lowercaseKeys } from \"./util/lowercase-keys\";\nimport { mergeDeep } from \"./util/merge-deep\";\nexport function merge(defaults, route, options) {\n if (typeof route === \"string\") {\n let [method, url] = route.split(\" \");\n options = Object.assign(url ? { method, url } : { url: method }, options);\n }\n else {\n options = Object.assign({}, route);\n }\n // lowercase header names before merging with defaults to avoid duplicates\n options.headers = lowercaseKeys(options.headers);\n const mergedOptions = mergeDeep(defaults || {}, options);\n // mediaType.previews arrays are merged, instead of overwritten\n if (defaults && defaults.mediaType.previews.length) {\n mergedOptions.mediaType.previews = defaults.mediaType.previews\n .filter((preview) => !mergedOptions.mediaType.previews.includes(preview))\n .concat(mergedOptions.mediaType.previews);\n }\n mergedOptions.mediaType.previews = mergedOptions.mediaType.previews.map((preview) => preview.replace(/-preview/, \"\"));\n return mergedOptions;\n}\n","export function addQueryParameters(url, parameters) {\n const separator = /\\?/.test(url) ? \"&\" : \"?\";\n const names = Object.keys(parameters);\n if (names.length === 0) {\n return url;\n }\n return (url +\n separator +\n names\n .map((name) => {\n if (name === \"q\") {\n return (\"q=\" + parameters.q.split(\"+\").map(encodeURIComponent).join(\"+\"));\n }\n return `${name}=${encodeURIComponent(parameters[name])}`;\n })\n .join(\"&\"));\n}\n","const urlVariableRegex = /\\{[^}]+\\}/g;\nfunction removeNonChars(variableName) {\n return variableName.replace(/^\\W+|\\W+$/g, \"\").split(/,/);\n}\nexport function extractUrlVariableNames(url) {\n const matches = url.match(urlVariableRegex);\n if (!matches) {\n return [];\n }\n return matches.map(removeNonChars).reduce((a, b) => a.concat(b), []);\n}\n","export function omit(object, keysToOmit) {\n return Object.keys(object)\n .filter((option) => !keysToOmit.includes(option))\n .reduce((obj, key) => {\n obj[key] = object[key];\n return obj;\n }, {});\n}\n","// Based on https://github.com/bramstein/url-template, licensed under BSD\n// TODO: create separate package.\n//\n// Copyright (c) 2012-2014, Bram Stein\n// All rights reserved.\n// Redistribution and use in source and binary forms, with or without\n// modification, are permitted provided that the following conditions\n// are met:\n// 1. Redistributions of source code must retain the above copyright\n// notice, this list of conditions and the following disclaimer.\n// 2. Redistributions in binary form must reproduce the above copyright\n// notice, this list of conditions and the following disclaimer in the\n// documentation and/or other materials provided with the distribution.\n// 3. The name of the author may not be used to endorse or promote products\n// derived from this software without specific prior written permission.\n// THIS SOFTWARE IS PROVIDED BY THE AUTHOR \"AS IS\" AND ANY EXPRESS OR IMPLIED\n// WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF\n// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO\n// EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,\n// INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,\n// BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,\n// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY\n// OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING\n// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,\n// EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n/* istanbul ignore file */\nfunction encodeReserved(str) {\n return str\n .split(/(%[0-9A-Fa-f]{2})/g)\n .map(function (part) {\n if (!/%[0-9A-Fa-f]/.test(part)) {\n part = encodeURI(part).replace(/%5B/g, \"[\").replace(/%5D/g, \"]\");\n }\n return part;\n })\n .join(\"\");\n}\nfunction encodeUnreserved(str) {\n return encodeURIComponent(str).replace(/[!'()*]/g, function (c) {\n return \"%\" + c.charCodeAt(0).toString(16).toUpperCase();\n });\n}\nfunction encodeValue(operator, value, key) {\n value =\n operator === \"+\" || operator === \"#\"\n ? encodeReserved(value)\n : encodeUnreserved(value);\n if (key) {\n return encodeUnreserved(key) + \"=\" + value;\n }\n else {\n return value;\n }\n}\nfunction isDefined(value) {\n return value !== undefined && value !== null;\n}\nfunction isKeyOperator(operator) {\n return operator === \";\" || operator === \"&\" || operator === \"?\";\n}\nfunction getValues(context, operator, key, modifier) {\n var value = context[key], result = [];\n if (isDefined(value) && value !== \"\") {\n if (typeof value === \"string\" ||\n typeof value === \"number\" ||\n typeof value === \"boolean\") {\n value = value.toString();\n if (modifier && modifier !== \"*\") {\n value = value.substring(0, parseInt(modifier, 10));\n }\n result.push(encodeValue(operator, value, isKeyOperator(operator) ? key : \"\"));\n }\n else {\n if (modifier === \"*\") {\n if (Array.isArray(value)) {\n value.filter(isDefined).forEach(function (value) {\n result.push(encodeValue(operator, value, isKeyOperator(operator) ? key : \"\"));\n });\n }\n else {\n Object.keys(value).forEach(function (k) {\n if (isDefined(value[k])) {\n result.push(encodeValue(operator, value[k], k));\n }\n });\n }\n }\n else {\n const tmp = [];\n if (Array.isArray(value)) {\n value.filter(isDefined).forEach(function (value) {\n tmp.push(encodeValue(operator, value));\n });\n }\n else {\n Object.keys(value).forEach(function (k) {\n if (isDefined(value[k])) {\n tmp.push(encodeUnreserved(k));\n tmp.push(encodeValue(operator, value[k].toString()));\n }\n });\n }\n if (isKeyOperator(operator)) {\n result.push(encodeUnreserved(key) + \"=\" + tmp.join(\",\"));\n }\n else if (tmp.length !== 0) {\n result.push(tmp.join(\",\"));\n }\n }\n }\n }\n else {\n if (operator === \";\") {\n if (isDefined(value)) {\n result.push(encodeUnreserved(key));\n }\n }\n else if (value === \"\" && (operator === \"&\" || operator === \"?\")) {\n result.push(encodeUnreserved(key) + \"=\");\n }\n else if (value === \"\") {\n result.push(\"\");\n }\n }\n return result;\n}\nexport function parseUrl(template) {\n return {\n expand: expand.bind(null, template),\n };\n}\nfunction expand(template, context) {\n var operators = [\"+\", \"#\", \".\", \"/\", \";\", \"?\", \"&\"];\n return template.replace(/\\{([^\\{\\}]+)\\}|([^\\{\\}]+)/g, function (_, expression, literal) {\n if (expression) {\n let operator = \"\";\n const values = [];\n if (operators.indexOf(expression.charAt(0)) !== -1) {\n operator = expression.charAt(0);\n expression = expression.substr(1);\n }\n expression.split(/,/g).forEach(function (variable) {\n var tmp = /([^:\\*]*)(?::(\\d+)|(\\*))?/.exec(variable);\n values.push(getValues(context, operator, tmp[1], tmp[2] || tmp[3]));\n });\n if (operator && operator !== \"+\") {\n var separator = \",\";\n if (operator === \"?\") {\n separator = \"&\";\n }\n else if (operator !== \"#\") {\n separator = operator;\n }\n return (values.length !== 0 ? operator : \"\") + values.join(separator);\n }\n else {\n return values.join(\",\");\n }\n }\n else {\n return encodeReserved(literal);\n }\n });\n}\n","import { addQueryParameters } from \"./util/add-query-parameters\";\nimport { extractUrlVariableNames } from \"./util/extract-url-variable-names\";\nimport { omit } from \"./util/omit\";\nimport { parseUrl } from \"./util/url-template\";\nexport function parse(options) {\n // https://fetch.spec.whatwg.org/#methods\n let method = options.method.toUpperCase();\n // replace :varname with {varname} to make it RFC 6570 compatible\n let url = (options.url || \"/\").replace(/:([a-z]\\w+)/g, \"{+$1}\");\n let headers = Object.assign({}, options.headers);\n let body;\n let parameters = omit(options, [\n \"method\",\n \"baseUrl\",\n \"url\",\n \"headers\",\n \"request\",\n \"mediaType\",\n ]);\n // extract variable names from URL to calculate remaining variables later\n const urlVariableNames = extractUrlVariableNames(url);\n url = parseUrl(url).expand(parameters);\n if (!/^http/.test(url)) {\n url = options.baseUrl + url;\n }\n const omittedParameters = Object.keys(options)\n .filter((option) => urlVariableNames.includes(option))\n .concat(\"baseUrl\");\n const remainingParameters = omit(parameters, omittedParameters);\n const isBinaryRequset = /application\\/octet-stream/i.test(headers.accept);\n if (!isBinaryRequset) {\n if (options.mediaType.format) {\n // e.g. application/vnd.github.v3+json => application/vnd.github.v3.raw\n headers.accept = headers.accept\n .split(/,/)\n .map((preview) => preview.replace(/application\\/vnd(\\.\\w+)(\\.v3)?(\\.\\w+)?(\\+json)?$/, `application/vnd$1$2.${options.mediaType.format}`))\n .join(\",\");\n }\n if (options.mediaType.previews.length) {\n const previewsFromAcceptHeader = headers.accept.match(/[\\w-]+(?=-preview)/g) || [];\n headers.accept = previewsFromAcceptHeader\n .concat(options.mediaType.previews)\n .map((preview) => {\n const format = options.mediaType.format\n ? `.${options.mediaType.format}`\n : \"+json\";\n return `application/vnd.github.${preview}-preview${format}`;\n })\n .join(\",\");\n }\n }\n // for GET/HEAD requests, set URL query parameters from remaining parameters\n // for PATCH/POST/PUT/DELETE requests, set request body from remaining parameters\n if ([\"GET\", \"HEAD\"].includes(method)) {\n url = addQueryParameters(url, remainingParameters);\n }\n else {\n if (\"data\" in remainingParameters) {\n body = remainingParameters.data;\n }\n else {\n if (Object.keys(remainingParameters).length) {\n body = remainingParameters;\n }\n else {\n headers[\"content-length\"] = 0;\n }\n }\n }\n // default content-type for JSON if body is set\n if (!headers[\"content-type\"] && typeof body !== \"undefined\") {\n headers[\"content-type\"] = \"application/json; charset=utf-8\";\n }\n // GitHub expects 'content-length: 0' header for PUT/PATCH requests without body.\n // fetch does not allow to set `content-length` header, but we can set body to an empty string\n if ([\"PATCH\", \"PUT\"].includes(method) && typeof body === \"undefined\") {\n body = \"\";\n }\n // Only return body/request keys if present\n return Object.assign({ method, url, headers }, typeof body !== \"undefined\" ? { body } : null, options.request ? { request: options.request } : null);\n}\n","import { merge } from \"./merge\";\nimport { parse } from \"./parse\";\nexport function endpointWithDefaults(defaults, route, options) {\n return parse(merge(defaults, route, options));\n}\n","import { endpointWithDefaults } from \"./endpoint-with-defaults\";\nimport { merge } from \"./merge\";\nimport { parse } from \"./parse\";\nexport function withDefaults(oldDefaults, newDefaults) {\n const DEFAULTS = merge(oldDefaults, newDefaults);\n const endpoint = endpointWithDefaults.bind(null, DEFAULTS);\n return Object.assign(endpoint, {\n DEFAULTS,\n defaults: withDefaults.bind(null, DEFAULTS),\n merge: merge.bind(null, DEFAULTS),\n parse,\n });\n}\n","export const VERSION = \"6.0.1\";\n","import { getUserAgent } from \"universal-user-agent\";\nimport { VERSION } from \"./version\";\nconst userAgent = `octokit-endpoint.js/${VERSION} ${getUserAgent()}`;\n// DEFAULTS has all properties set that EndpointOptions has, except url.\n// So we use RequestParameters and add method as additional required property.\nexport const DEFAULTS = {\n method: \"GET\",\n baseUrl: \"https://api.github.com\",\n headers: {\n accept: \"application/vnd.github.v3+json\",\n \"user-agent\": userAgent,\n },\n mediaType: {\n format: \"\",\n previews: [],\n },\n};\n","import { withDefaults } from \"./with-defaults\";\nimport { DEFAULTS } from \"./defaults\";\nexport const endpoint = withDefaults(null, DEFAULTS);\n"],"names":[],"mappings":";;;AAAO,SAAS,aAAa,CAAC,MAAM,EAAE;AACtC,IAAI,IAAI,CAAC,MAAM,EAAE;AACjB,QAAQ,OAAO,EAAE,CAAC;AAClB,KAAK;AACL,IAAI,OAAO,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,GAAG,KAAK;AACvD,QAAQ,MAAM,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;AAChD,QAAQ,OAAO,MAAM,CAAC;AACtB,KAAK,EAAE,EAAE,CAAC,CAAC;AACX;;ACPO,SAAS,SAAS,CAAC,QAAQ,EAAE,OAAO,EAAE;AAC7C,IAAI,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAC;AAC/C,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,KAAK;AAC1C,QAAQ,IAAI,aAAa,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE;AACzC,YAAY,IAAI,EAAE,GAAG,IAAI,QAAQ,CAAC;AAClC,gBAAgB,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;AAC/D;AACA,gBAAgB,MAAM,CAAC,GAAG,CAAC,GAAG,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;AACrE,SAAS;AACT,aAAa;AACb,YAAY,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;AAC3D,SAAS;AACT,KAAK,CAAC,CAAC;AACP,IAAI,OAAO,MAAM,CAAC;AAClB,CAAC;;ACbM,SAAS,KAAK,CAAC,QAAQ,EAAE,KAAK,EAAE,OAAO,EAAE;AAChD,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;AACnC,QAAQ,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;AAC7C,QAAQ,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,GAAG,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;AAClF,KAAK;AACL,SAAS;AACT,QAAQ,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;AAC3C,KAAK;AACL;AACA,IAAI,OAAO,CAAC,OAAO,GAAG,aAAa,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;AACrD,IAAI,MAAM,aAAa,GAAG,SAAS,CAAC,QAAQ,IAAI,EAAE,EAAE,OAAO,CAAC,CAAC;AAC7D;AACA,IAAI,IAAI,QAAQ,IAAI,QAAQ,CAAC,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE;AACxD,QAAQ,aAAa,CAAC,SAAS,CAAC,QAAQ,GAAG,QAAQ,CAAC,SAAS,CAAC,QAAQ;AACtE,aAAa,MAAM,CAAC,CAAC,OAAO,KAAK,CAAC,aAAa,CAAC,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;AACrF,aAAa,MAAM,CAAC,aAAa,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;AACtD,KAAK;AACL,IAAI,aAAa,CAAC,SAAS,CAAC,QAAQ,GAAG,aAAa,CAAC,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,KAAK,OAAO,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC,CAAC;AAC1H,IAAI,OAAO,aAAa,CAAC;AACzB,CAAC;;ACrBM,SAAS,kBAAkB,CAAC,GAAG,EAAE,UAAU,EAAE;AACpD,IAAI,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,GAAG,GAAG,GAAG,CAAC;AACjD,IAAI,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;AAC1C,IAAI,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE;AAC5B,QAAQ,OAAO,GAAG,CAAC;AACnB,KAAK;AACL,IAAI,QAAQ,GAAG;AACf,QAAQ,SAAS;AACjB,QAAQ,KAAK;AACb,aAAa,GAAG,CAAC,CAAC,IAAI,KAAK;AAC3B,YAAY,IAAI,IAAI,KAAK,GAAG,EAAE;AAC9B,gBAAgB,QAAQ,IAAI,GAAG,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;AAC1F,aAAa;AACb,YAAY,OAAO,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,kBAAkB,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;AACrE,SAAS,CAAC;AACV,aAAa,IAAI,CAAC,GAAG,CAAC,EAAE;AACxB,CAAC;;AChBD,MAAM,gBAAgB,GAAG,YAAY,CAAC;AACtC,SAAS,cAAc,CAAC,YAAY,EAAE;AACtC,IAAI,OAAO,YAAY,CAAC,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;AAC7D,CAAC;AACD,AAAO,SAAS,uBAAuB,CAAC,GAAG,EAAE;AAC7C,IAAI,MAAM,OAAO,GAAG,GAAG,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;AAChD,IAAI,IAAI,CAAC,OAAO,EAAE;AAClB,QAAQ,OAAO,EAAE,CAAC;AAClB,KAAK;AACL,IAAI,OAAO,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;AACzE,CAAC;;ACVM,SAAS,IAAI,CAAC,MAAM,EAAE,UAAU,EAAE;AACzC,IAAI,OAAO,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC;AAC9B,SAAS,MAAM,CAAC,CAAC,MAAM,KAAK,CAAC,UAAU,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;AACzD,SAAS,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,KAAK;AAC9B,QAAQ,GAAG,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;AAC/B,QAAQ,OAAO,GAAG,CAAC;AACnB,KAAK,EAAE,EAAE,CAAC,CAAC;AACX,CAAC;;ACPD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,SAAS,cAAc,CAAC,GAAG,EAAE;AAC7B,IAAI,OAAO,GAAG;AACd,SAAS,KAAK,CAAC,oBAAoB,CAAC;AACpC,SAAS,GAAG,CAAC,UAAU,IAAI,EAAE;AAC7B,QAAQ,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;AACxC,YAAY,IAAI,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAC7E,SAAS;AACT,QAAQ,OAAO,IAAI,CAAC;AACpB,KAAK,CAAC;AACN,SAAS,IAAI,CAAC,EAAE,CAAC,CAAC;AAClB,CAAC;AACD,SAAS,gBAAgB,CAAC,GAAG,EAAE;AAC/B,IAAI,OAAO,kBAAkB,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,UAAU,EAAE,UAAU,CAAC,EAAE;AACpE,QAAQ,OAAO,GAAG,GAAG,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC;AAChE,KAAK,CAAC,CAAC;AACP,CAAC;AACD,SAAS,WAAW,CAAC,QAAQ,EAAE,KAAK,EAAE,GAAG,EAAE;AAC3C,IAAI,KAAK;AACT,QAAQ,QAAQ,KAAK,GAAG,IAAI,QAAQ,KAAK,GAAG;AAC5C,cAAc,cAAc,CAAC,KAAK,CAAC;AACnC,cAAc,gBAAgB,CAAC,KAAK,CAAC,CAAC;AACtC,IAAI,IAAI,GAAG,EAAE;AACb,QAAQ,OAAO,gBAAgB,CAAC,GAAG,CAAC,GAAG,GAAG,GAAG,KAAK,CAAC;AACnD,KAAK;AACL,SAAS;AACT,QAAQ,OAAO,KAAK,CAAC;AACrB,KAAK;AACL,CAAC;AACD,SAAS,SAAS,CAAC,KAAK,EAAE;AAC1B,IAAI,OAAO,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,CAAC;AACjD,CAAC;AACD,SAAS,aAAa,CAAC,QAAQ,EAAE;AACjC,IAAI,OAAO,QAAQ,KAAK,GAAG,IAAI,QAAQ,KAAK,GAAG,IAAI,QAAQ,KAAK,GAAG,CAAC;AACpE,CAAC;AACD,SAAS,SAAS,CAAC,OAAO,EAAE,QAAQ,EAAE,GAAG,EAAE,QAAQ,EAAE;AACrD,IAAI,IAAI,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,EAAE,MAAM,GAAG,EAAE,CAAC;AAC1C,IAAI,IAAI,SAAS,CAAC,KAAK,CAAC,IAAI,KAAK,KAAK,EAAE,EAAE;AAC1C,QAAQ,IAAI,OAAO,KAAK,KAAK,QAAQ;AACrC,YAAY,OAAO,KAAK,KAAK,QAAQ;AACrC,YAAY,OAAO,KAAK,KAAK,SAAS,EAAE;AACxC,YAAY,KAAK,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAC;AACrC,YAAY,IAAI,QAAQ,IAAI,QAAQ,KAAK,GAAG,EAAE;AAC9C,gBAAgB,KAAK,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,EAAE,QAAQ,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC;AACnE,aAAa;AACb,YAAY,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,KAAK,EAAE,aAAa,CAAC,QAAQ,CAAC,GAAG,GAAG,GAAG,EAAE,CAAC,CAAC,CAAC;AAC1F,SAAS;AACT,aAAa;AACb,YAAY,IAAI,QAAQ,KAAK,GAAG,EAAE;AAClC,gBAAgB,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;AAC1C,oBAAoB,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,UAAU,KAAK,EAAE;AACrE,wBAAwB,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,KAAK,EAAE,aAAa,CAAC,QAAQ,CAAC,GAAG,GAAG,GAAG,EAAE,CAAC,CAAC,CAAC;AACtG,qBAAqB,CAAC,CAAC;AACvB,iBAAiB;AACjB,qBAAqB;AACrB,oBAAoB,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE;AAC5D,wBAAwB,IAAI,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE;AACjD,4BAA4B,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;AAC5E,yBAAyB;AACzB,qBAAqB,CAAC,CAAC;AACvB,iBAAiB;AACjB,aAAa;AACb,iBAAiB;AACjB,gBAAgB,MAAM,GAAG,GAAG,EAAE,CAAC;AAC/B,gBAAgB,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;AAC1C,oBAAoB,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,UAAU,KAAK,EAAE;AACrE,wBAAwB,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC;AAC/D,qBAAqB,CAAC,CAAC;AACvB,iBAAiB;AACjB,qBAAqB;AACrB,oBAAoB,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE;AAC5D,wBAAwB,IAAI,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE;AACjD,4BAA4B,GAAG,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC;AAC1D,4BAA4B,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;AACjF,yBAAyB;AACzB,qBAAqB,CAAC,CAAC;AACvB,iBAAiB;AACjB,gBAAgB,IAAI,aAAa,CAAC,QAAQ,CAAC,EAAE;AAC7C,oBAAoB,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,GAAG,GAAG,GAAG,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;AAC7E,iBAAiB;AACjB,qBAAqB,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC,EAAE;AAC3C,oBAAoB,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;AAC/C,iBAAiB;AACjB,aAAa;AACb,SAAS;AACT,KAAK;AACL,SAAS;AACT,QAAQ,IAAI,QAAQ,KAAK,GAAG,EAAE;AAC9B,YAAY,IAAI,SAAS,CAAC,KAAK,CAAC,EAAE;AAClC,gBAAgB,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,CAAC;AACnD,aAAa;AACb,SAAS;AACT,aAAa,IAAI,KAAK,KAAK,EAAE,KAAK,QAAQ,KAAK,GAAG,IAAI,QAAQ,KAAK,GAAG,CAAC,EAAE;AACzE,YAAY,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,CAAC;AACrD,SAAS;AACT,aAAa,IAAI,KAAK,KAAK,EAAE,EAAE;AAC/B,YAAY,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AAC5B,SAAS;AACT,KAAK;AACL,IAAI,OAAO,MAAM,CAAC;AAClB,CAAC;AACD,AAAO,SAAS,QAAQ,CAAC,QAAQ,EAAE;AACnC,IAAI,OAAO;AACX,QAAQ,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC;AAC3C,KAAK,CAAC;AACN,CAAC;AACD,SAAS,MAAM,CAAC,QAAQ,EAAE,OAAO,EAAE;AACnC,IAAI,IAAI,SAAS,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;AACxD,IAAI,OAAO,QAAQ,CAAC,OAAO,CAAC,4BAA4B,EAAE,UAAU,CAAC,EAAE,UAAU,EAAE,OAAO,EAAE;AAC5F,QAAQ,IAAI,UAAU,EAAE;AACxB,YAAY,IAAI,QAAQ,GAAG,EAAE,CAAC;AAC9B,YAAY,MAAM,MAAM,GAAG,EAAE,CAAC;AAC9B,YAAY,IAAI,SAAS,CAAC,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE;AAChE,gBAAgB,QAAQ,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;AAChD,gBAAgB,UAAU,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;AAClD,aAAa;AACb,YAAY,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,UAAU,QAAQ,EAAE;AAC/D,gBAAgB,IAAI,GAAG,GAAG,2BAA2B,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;AACrE,gBAAgB,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,QAAQ,EAAE,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AACpF,aAAa,CAAC,CAAC;AACf,YAAY,IAAI,QAAQ,IAAI,QAAQ,KAAK,GAAG,EAAE;AAC9C,gBAAgB,IAAI,SAAS,GAAG,GAAG,CAAC;AACpC,gBAAgB,IAAI,QAAQ,KAAK,GAAG,EAAE;AACtC,oBAAoB,SAAS,GAAG,GAAG,CAAC;AACpC,iBAAiB;AACjB,qBAAqB,IAAI,QAAQ,KAAK,GAAG,EAAE;AAC3C,oBAAoB,SAAS,GAAG,QAAQ,CAAC;AACzC,iBAAiB;AACjB,gBAAgB,OAAO,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,GAAG,QAAQ,GAAG,EAAE,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;AACtF,aAAa;AACb,iBAAiB;AACjB,gBAAgB,OAAO,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACxC,aAAa;AACb,SAAS;AACT,aAAa;AACb,YAAY,OAAO,cAAc,CAAC,OAAO,CAAC,CAAC;AAC3C,SAAS;AACT,KAAK,CAAC,CAAC;AACP,CAAC;;AC/JM,SAAS,KAAK,CAAC,OAAO,EAAE;AAC/B;AACA,IAAI,IAAI,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;AAC9C;AACA,IAAI,IAAI,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,IAAI,GAAG,EAAE,OAAO,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;AACpE,IAAI,IAAI,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;AACrD,IAAI,IAAI,IAAI,CAAC;AACb,IAAI,IAAI,UAAU,GAAG,IAAI,CAAC,OAAO,EAAE;AACnC,QAAQ,QAAQ;AAChB,QAAQ,SAAS;AACjB,QAAQ,KAAK;AACb,QAAQ,SAAS;AACjB,QAAQ,SAAS;AACjB,QAAQ,WAAW;AACnB,KAAK,CAAC,CAAC;AACP;AACA,IAAI,MAAM,gBAAgB,GAAG,uBAAuB,CAAC,GAAG,CAAC,CAAC;AAC1D,IAAI,GAAG,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;AAC3C,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;AAC5B,QAAQ,GAAG,GAAG,OAAO,CAAC,OAAO,GAAG,GAAG,CAAC;AACpC,KAAK;AACL,IAAI,MAAM,iBAAiB,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC;AAClD,SAAS,MAAM,CAAC,CAAC,MAAM,KAAK,gBAAgB,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;AAC9D,SAAS,MAAM,CAAC,SAAS,CAAC,CAAC;AAC3B,IAAI,MAAM,mBAAmB,GAAG,IAAI,CAAC,UAAU,EAAE,iBAAiB,CAAC,CAAC;AACpE,IAAI,MAAM,eAAe,GAAG,4BAA4B,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;AAC9E,IAAI,IAAI,CAAC,eAAe,EAAE;AAC1B,QAAQ,IAAI,OAAO,CAAC,SAAS,CAAC,MAAM,EAAE;AACtC;AACA,YAAY,OAAO,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM;AAC3C,iBAAiB,KAAK,CAAC,GAAG,CAAC;AAC3B,iBAAiB,GAAG,CAAC,CAAC,OAAO,KAAK,OAAO,CAAC,OAAO,CAAC,kDAAkD,EAAE,CAAC,oBAAoB,EAAE,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;AACzJ,iBAAiB,IAAI,CAAC,GAAG,CAAC,CAAC;AAC3B,SAAS;AACT,QAAQ,IAAI,OAAO,CAAC,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE;AAC/C,YAAY,MAAM,wBAAwB,GAAG,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,qBAAqB,CAAC,IAAI,EAAE,CAAC;AAC/F,YAAY,OAAO,CAAC,MAAM,GAAG,wBAAwB;AACrD,iBAAiB,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,QAAQ,CAAC;AACnD,iBAAiB,GAAG,CAAC,CAAC,OAAO,KAAK;AAClC,gBAAgB,MAAM,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC,MAAM;AACvD,sBAAsB,CAAC,CAAC,EAAE,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;AACpD,sBAAsB,OAAO,CAAC;AAC9B,gBAAgB,OAAO,CAAC,uBAAuB,EAAE,OAAO,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAC;AAC5E,aAAa,CAAC;AACd,iBAAiB,IAAI,CAAC,GAAG,CAAC,CAAC;AAC3B,SAAS;AACT,KAAK;AACL;AACA;AACA,IAAI,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;AAC1C,QAAQ,GAAG,GAAG,kBAAkB,CAAC,GAAG,EAAE,mBAAmB,CAAC,CAAC;AAC3D,KAAK;AACL,SAAS;AACT,QAAQ,IAAI,MAAM,IAAI,mBAAmB,EAAE;AAC3C,YAAY,IAAI,GAAG,mBAAmB,CAAC,IAAI,CAAC;AAC5C,SAAS;AACT,aAAa;AACb,YAAY,IAAI,MAAM,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC,MAAM,EAAE;AACzD,gBAAgB,IAAI,GAAG,mBAAmB,CAAC;AAC3C,aAAa;AACb,iBAAiB;AACjB,gBAAgB,OAAO,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC;AAC9C,aAAa;AACb,SAAS;AACT,KAAK;AACL;AACA,IAAI,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,IAAI,OAAO,IAAI,KAAK,WAAW,EAAE;AACjE,QAAQ,OAAO,CAAC,cAAc,CAAC,GAAG,iCAAiC,CAAC;AACpE,KAAK;AACL;AACA;AACA,IAAI,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,OAAO,IAAI,KAAK,WAAW,EAAE;AAC1E,QAAQ,IAAI,GAAG,EAAE,CAAC;AAClB,KAAK;AACL;AACA,IAAI,OAAO,MAAM,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,EAAE,OAAO,IAAI,KAAK,WAAW,GAAG,EAAE,IAAI,EAAE,GAAG,IAAI,EAAE,OAAO,CAAC,OAAO,GAAG,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,CAAC;AACzJ,CAAC;;AC9EM,SAAS,oBAAoB,CAAC,QAAQ,EAAE,KAAK,EAAE,OAAO,EAAE;AAC/D,IAAI,OAAO,KAAK,CAAC,KAAK,CAAC,QAAQ,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC;AAClD,CAAC;;ACDM,SAAS,YAAY,CAAC,WAAW,EAAE,WAAW,EAAE;AACvD,IAAI,MAAM,QAAQ,GAAG,KAAK,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;AACrD,IAAI,MAAM,QAAQ,GAAG,oBAAoB,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;AAC/D,IAAI,OAAO,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE;AACnC,QAAQ,QAAQ;AAChB,QAAQ,QAAQ,EAAE,YAAY,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC;AACnD,QAAQ,KAAK,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC;AACzC,QAAQ,KAAK;AACb,KAAK,CAAC,CAAC;AACP,CAAC;;ACZM,MAAM,OAAO,GAAG,mBAAmB,CAAC;;ACE3C,MAAM,SAAS,GAAG,CAAC,oBAAoB,EAAE,OAAO,CAAC,CAAC,EAAE,YAAY,EAAE,CAAC,CAAC,CAAC;AACrE;AACA;AACA,AAAO,MAAM,QAAQ,GAAG;AACxB,IAAI,MAAM,EAAE,KAAK;AACjB,IAAI,OAAO,EAAE,wBAAwB;AACrC,IAAI,OAAO,EAAE;AACb,QAAQ,MAAM,EAAE,gCAAgC;AAChD,QAAQ,YAAY,EAAE,SAAS;AAC/B,KAAK;AACL,IAAI,SAAS,EAAE;AACf,QAAQ,MAAM,EAAE,EAAE;AAClB,QAAQ,QAAQ,EAAE,EAAE;AACpB,KAAK;AACL,CAAC,CAAC;;ACdU,MAAC,QAAQ,GAAG,YAAY,CAAC,IAAI,EAAE,QAAQ,CAAC;;;;"} \ No newline at end of file diff --git a/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-node/index.js b/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-node/index.js index 80a0710..c2534ce 100644 --- a/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-node/index.js +++ b/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-node/index.js @@ -14,7 +14,7 @@ function getUserAgent() { return "Windows "; } - throw error; + return ""; } } diff --git a/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-node/index.js.map b/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-node/index.js.map index aff09ec..6f15e8d 100644 --- a/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-node/index.js.map +++ b/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-node/index.js.map @@ -1 +1 @@ -{"version":3,"file":"index.js","sources":["../dist-src/node.js"],"sourcesContent":["import osName from \"os-name\";\nexport function getUserAgent() {\n try {\n return `Node.js/${process.version.substr(1)} (${osName()}; ${process.arch})`;\n }\n catch (error) {\n if (/wmic os get Caption/.test(error.message)) {\n return \"Windows \";\n }\n throw error;\n }\n}\n"],"names":["getUserAgent","process","version","substr","osName","arch","error","test","message"],"mappings":";;;;;;;;AACO,SAASA,YAAT,GAAwB;MACvB;WACQ,WAAUC,OAAO,CAACC,OAAR,CAAgBC,MAAhB,CAAuB,CAAvB,CAA0B,KAAIC,MAAM,EAAG,KAAIH,OAAO,CAACI,IAAK,GAA1E;GADJ,CAGA,OAAOC,KAAP,EAAc;QACN,sBAAsBC,IAAtB,CAA2BD,KAAK,CAACE,OAAjC,CAAJ,EAA+C;aACpC,gCAAP;;;UAEEF,KAAN;;;;;;"} \ No newline at end of file +{"version":3,"file":"index.js","sources":["../dist-src/node.js"],"sourcesContent":["import osName from \"os-name\";\nexport function getUserAgent() {\n try {\n return `Node.js/${process.version.substr(1)} (${osName()}; ${process.arch})`;\n }\n catch (error) {\n if (/wmic os get Caption/.test(error.message)) {\n return \"Windows \";\n }\n return \"\";\n }\n}\n"],"names":["getUserAgent","process","version","substr","osName","arch","error","test","message"],"mappings":";;;;;;;;AACO,SAASA,YAAT,GAAwB;MACvB;WACQ,WAAUC,OAAO,CAACC,OAAR,CAAgBC,MAAhB,CAAuB,CAAvB,CAA0B,KAAIC,MAAM,EAAG,KAAIH,OAAO,CAACI,IAAK,GAA1E;GADJ,CAGA,OAAOC,KAAP,EAAc;QACN,sBAAsBC,IAAtB,CAA2BD,KAAK,CAACE,OAAjC,CAAJ,EAA+C;aACpC,gCAAP;;;WAEG,4BAAP;;;;;;"} \ No newline at end of file diff --git a/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-src/browser.js b/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-src/browser.js index 6f52232..8903ac9 100644 --- a/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-src/browser.js +++ b/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-src/browser.js @@ -1,3 +1,8 @@ export function getUserAgent() { - return navigator.userAgent; + try { + return navigator.userAgent; + } + catch (e) { + return ""; + } } diff --git a/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-src/node.js b/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-src/node.js index 8b70a03..ba148f0 100644 --- a/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-src/node.js +++ b/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-src/node.js @@ -7,6 +7,6 @@ export function getUserAgent() { if (/wmic os get Caption/.test(error.message)) { return "Windows "; } - throw error; + return ""; } } diff --git a/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-web/index.js b/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-web/index.js index 11ec79b..c76d6e5 100644 --- a/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-web/index.js +++ b/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-web/index.js @@ -1,5 +1,10 @@ function getUserAgent() { - return navigator.userAgent; + try { + return navigator.userAgent; + } + catch (e) { + return ""; + } } export { getUserAgent }; diff --git a/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-web/index.js.map b/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-web/index.js.map index 549407e..f4b20c3 100644 --- a/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-web/index.js.map +++ b/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-web/index.js.map @@ -1 +1 @@ -{"version":3,"file":"index.js","sources":["../dist-src/browser.js"],"sourcesContent":["export function getUserAgent() {\n return navigator.userAgent;\n}\n"],"names":[],"mappings":"AAAO,SAAS,YAAY,GAAG;IAC3B,OAAO,SAAS,CAAC,SAAS,CAAC;CAC9B;;;;"} \ No newline at end of file +{"version":3,"file":"index.js","sources":["../dist-src/browser.js"],"sourcesContent":["export function getUserAgent() {\n try {\n return navigator.userAgent;\n }\n catch (e) {\n return \"\";\n }\n}\n"],"names":[],"mappings":"AAAO,SAAS,YAAY,GAAG;IAC3B,IAAI;QACA,OAAO,SAAS,CAAC,SAAS,CAAC;KAC9B;IACD,OAAO,CAAC,EAAE;QACN,OAAO,4BAA4B,CAAC;KACvC;CACJ;;;;"} \ No newline at end of file diff --git a/node_modules/@octokit/endpoint/node_modules/universal-user-agent/package.json b/node_modules/@octokit/endpoint/node_modules/universal-user-agent/package.json index 2e3b0e2..67f7e81 100644 --- a/node_modules/@octokit/endpoint/node_modules/universal-user-agent/package.json +++ b/node_modules/@octokit/endpoint/node_modules/universal-user-agent/package.json @@ -1,46 +1,49 @@ { - "_from": "universal-user-agent@^4.0.0", - "_id": "universal-user-agent@4.0.0", + "_args": [ + [ + "universal-user-agent@5.0.0", + "/Users/marocchino/Documents/sticky-pull-request-comment" + ] + ], + "_from": "universal-user-agent@5.0.0", + "_id": "universal-user-agent@5.0.0", "_inBundle": false, - "_integrity": "sha512-eM8knLpev67iBDizr/YtqkJsF3GK8gzDc6st/WKzrTuPtcsOKW/0IdL4cnMBsU69pOx0otavLWBDGTwg+dB0aA==", + "_integrity": "sha512-B5TPtzZleXyPrUMKCpEHFmVhMN6EhmJYjG5PQna9s7mXeSqGTLap4OpqLl5FCEFUI3UBmllkETwKf/db66Y54Q==", "_location": "/@octokit/endpoint/universal-user-agent", "_phantomChildren": {}, "_requested": { - "type": "range", + "type": "version", "registry": true, - "raw": "universal-user-agent@^4.0.0", + "raw": "universal-user-agent@5.0.0", "name": "universal-user-agent", "escapedName": "universal-user-agent", - "rawSpec": "^4.0.0", + "rawSpec": "5.0.0", "saveSpec": null, - "fetchSpec": "^4.0.0" + "fetchSpec": "5.0.0" }, "_requiredBy": [ "/@octokit/endpoint" ], - "_resolved": "https://registry.npmjs.org/universal-user-agent/-/universal-user-agent-4.0.0.tgz", - "_shasum": "27da2ec87e32769619f68a14996465ea1cb9df16", - "_spec": "universal-user-agent@^4.0.0", - "_where": "/Users/shim.taewon/Documents/sticky-pull-request-comment/node_modules/@octokit/endpoint", + "_resolved": "https://registry.npmjs.org/universal-user-agent/-/universal-user-agent-5.0.0.tgz", + "_spec": "5.0.0", + "_where": "/Users/marocchino/Documents/sticky-pull-request-comment", "bugs": { "url": "https://github.com/gr2m/universal-user-agent/issues" }, - "bundleDependencies": false, "dependencies": { "os-name": "^3.1.0" }, - "deprecated": false, "description": "Get a user agent string in both browser and node", "devDependencies": { "@gr2m/pika-plugin-build-web": "^0.6.0-issue-84.1", "@pika/pack": "^0.5.0", - "@pika/plugin-build-node": "^0.6.0", - "@pika/plugin-ts-standard-pkg": "^0.6.0", - "@types/jest": "^24.0.18", + "@pika/plugin-build-node": "^0.9.1", + "@pika/plugin-ts-standard-pkg": "^0.9.1", + "@types/jest": "^25.1.0", "jest": "^24.9.0", "prettier": "^1.18.2", - "semantic-release": "^15.9.15", - "ts-jest": "^24.0.2", + "semantic-release": "^17.0.0", + "ts-jest": "^25.1.0", "typescript": "^3.6.2" }, "files": [ @@ -61,5 +64,5 @@ "sideEffects": false, "source": "dist-src/index.js", "types": "dist-types/index.d.ts", - "version": "4.0.0" + "version": "5.0.0" } diff --git a/node_modules/@octokit/endpoint/package.json b/node_modules/@octokit/endpoint/package.json index 5e21d95..8689dbb 100644 --- a/node_modules/@octokit/endpoint/package.json +++ b/node_modules/@octokit/endpoint/package.json @@ -1,53 +1,55 @@ { - "_from": "@octokit/endpoint@^5.5.0", - "_id": "@octokit/endpoint@5.5.1", + "_args": [ + [ + "@octokit/endpoint@6.0.1", + "/Users/marocchino/Documents/sticky-pull-request-comment" + ] + ], + "_from": "@octokit/endpoint@6.0.1", + "_id": "@octokit/endpoint@6.0.1", "_inBundle": false, - "_integrity": "sha512-nBFhRUb5YzVTCX/iAK1MgQ4uWo89Gu0TH00qQHoYRCsE12dWcG1OiLd7v2EIo2+tpUKPMOQ62QFy9hy9Vg2ULg==", + "_integrity": "sha512-pOPHaSz57SFT/m3R5P8MUu4wLPszokn5pXcB/pzavLTQf2jbU+6iayTvzaY6/BiotuRS0qyEUkx3QglT4U958A==", "_location": "/@octokit/endpoint", "_phantomChildren": { "os-name": "3.1.0" }, "_requested": { - "type": "range", + "type": "version", "registry": true, - "raw": "@octokit/endpoint@^5.5.0", + "raw": "@octokit/endpoint@6.0.1", "name": "@octokit/endpoint", "escapedName": "@octokit%2fendpoint", "scope": "@octokit", - "rawSpec": "^5.5.0", + "rawSpec": "6.0.1", "saveSpec": null, - "fetchSpec": "^5.5.0" + "fetchSpec": "6.0.1" }, "_requiredBy": [ "/@octokit/request" ], - "_resolved": "https://registry.npmjs.org/@octokit/endpoint/-/endpoint-5.5.1.tgz", - "_shasum": "2eea81e110ca754ff2de11c79154ccab4ae16b3f", - "_spec": "@octokit/endpoint@^5.5.0", - "_where": "/Users/shim.taewon/Documents/sticky-pull-request-comment/node_modules/@octokit/request", + "_resolved": "https://registry.npmjs.org/@octokit/endpoint/-/endpoint-6.0.1.tgz", + "_spec": "6.0.1", + "_where": "/Users/marocchino/Documents/sticky-pull-request-comment", "bugs": { "url": "https://github.com/octokit/endpoint.js/issues" }, - "bundleDependencies": false, - "deno": "dist-web/index.js", "dependencies": { - "@octokit/types": "^2.0.0", + "@octokit/types": "^2.11.1", "is-plain-object": "^3.0.0", - "universal-user-agent": "^4.0.0" + "universal-user-agent": "^5.0.0" }, - "deprecated": false, "description": "Turns REST API endpoints into generic request options", "devDependencies": { "@pika/pack": "^0.5.0", - "@pika/plugin-build-node": "^0.7.0", - "@pika/plugin-build-web": "^0.7.0", - "@pika/plugin-ts-standard-pkg": "^0.7.0", - "@types/jest": "^24.0.11", + "@pika/plugin-build-node": "^0.9.0", + "@pika/plugin-build-web": "^0.9.0", + "@pika/plugin-ts-standard-pkg": "^0.9.0", + "@types/jest": "^25.1.0", "jest": "^24.7.1", - "prettier": "1.18.2", - "semantic-release": "^15.13.8", + "prettier": "2.0.3", + "semantic-release": "^17.0.0", "semantic-release-plugin-update-version-in-files": "^1.0.0", - "ts-jest": "^24.0.2", + "ts-jest": "^25.1.0", "typescript": "^3.4.5" }, "files": [ @@ -63,6 +65,7 @@ ], "license": "MIT", "main": "dist-node/index.js", + "module": "dist-web/index.js", "name": "@octokit/endpoint", "pika": true, "publishConfig": { @@ -75,5 +78,5 @@ "sideEffects": false, "source": "dist-src/index.js", "types": "dist-types/index.d.ts", - "version": "5.5.1" + "version": "6.0.1" } diff --git a/node_modules/@octokit/graphql/README.md b/node_modules/@octokit/graphql/README.md index 4e44592..dd797d9 100644 --- a/node_modules/@octokit/graphql/README.md +++ b/node_modules/@octokit/graphql/README.md @@ -4,13 +4,18 @@ [![@latest](https://img.shields.io/npm/v/@octokit/graphql.svg)](https://www.npmjs.com/package/@octokit/graphql) [![Build Status](https://travis-ci.com/octokit/graphql.js.svg?branch=master)](https://travis-ci.com/octokit/graphql.js) -[![Coverage Status](https://coveralls.io/repos/github/octokit/graphql.js/badge.svg)](https://coveralls.io/github/octokit/graphql.js) [![Greenkeeper](https://badges.greenkeeper.io/octokit/graphql.js.svg)](https://greenkeeper.io/) - [Usage](#usage) + - [Send a simple query](#send-a-simple-query) + - [Authentication](#authentication) + - [Variables](#variables) + - [Pass query together with headers and variables](#pass-query-together-with-headers-and-variables) + - [Use your own `@octokit/request` instance](#) - [Errors](#errors) +- [Partial responses](#partial-responses) - [Writing tests](#writing-tests) - [License](#license) @@ -18,31 +23,121 @@ ## Usage -Send a simple query + + + + + +
+Browsers + + +Load `@octokit/graphql` directly from [cdn.pika.dev](https://cdn.pika.dev) + +```html + +``` + +
+Node + + +Install with npm install @octokit/graphql ```js -const graphql = require('@octokit/graphql') -const { repository } = await graphql(`{ - repository(owner:"octokit", name:"graphql.js") { - issues(last:3) { - edges { - node { - title +const { graphql } = require("@octokit/graphql"); +// or: import { graphql } from "@octokit/graphql"; +``` + +
+ +### Send a simple query + +```js +const { repository } = await graphql( + ` + { + repository(owner: "octokit", name: "graphql.js") { + issues(last: 3) { + edges { + node { + title + } + } + } + } + } + `, + { + headers: { + authorization: `token secret123` + } + } +); +``` + +### Authentication + +The simplest way to authenticate a request is to set the `Authorization` header, e.g. to a [personal access token](https://github.com/settings/tokens/). + +```js +const graphqlWithAuth = graphql.defaults({ + headers: { + authorization: `token secret123` + } +}); +const { repository } = await graphqlWithAuth(` + { + repository(owner: "octokit", name: "graphql.js") { + issues(last: 3) { + edges { + node { + title + } } } } } -}`, { - headers: { - authorization: `token secret123` - } -}) +`); ``` +For more complex authentication strategies such as GitHub Apps or Basic, we recommend the according authentication library exported by [`@octokit/auth`](https://github.com/octokit/auth.js). + +```js +const { createAppAuth } = require("@octokit/auth-app"); +const auth = createAppAuth({ + id: process.env.APP_ID, + privateKey: process.env.PRIVATE_KEY, + installationId: 123 +}); +const graphqlWithAuth = graphql.defaults({ + request: { + hook: auth.hook + } +}); + +const { repository } = await graphqlWithAuth( + `{ + repository(owner: "octokit", name: "graphql.js") { + issues(last: 3) { + edges { + node { + title + } + } + } + } + }` +); +``` + +### Variables + ⚠️ Do not use [template literals](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Template_literals) in the query strings as they make your code vulnerable to query injection attacks (see [#2](https://github.com/octokit/graphql.js/issues/2)). Use variables instead: ```js -const graphql = require('@octokit/graphql') const { lastIssues } = await graphql(`query lastIssues($owner: String!, $repo: String!, $num: Int = 3) { repository(owner:$owner, name:$repo) { issues(last:$num) { @@ -63,63 +158,10 @@ const { lastIssues } = await graphql(`query lastIssues($owner: String!, $repo: S }) ``` -Create two new clients and set separate default configs for them. +### Pass query together with headers and variables ```js -const graphql1 = require('@octokit/graphql').defaults({ - headers: { - authorization: `token secret123` - } -}) - -const graphql2 = require('@octokit/graphql').defaults({ - headers: { - authorization: `token foobar` - } -}) -``` - -Create two clients, the second inherits config from the first. - -```js -const graphql1 = require('@octokit/graphql').defaults({ - headers: { - authorization: `token secret123` - } -}) - -const graphql2 = graphql1.defaults({ - headers: { - 'user-agent': 'my-user-agent/v1.2.3' - } -}) -``` - -Create a new client with default options and run query - -```js -const graphql = require('@octokit/graphql').defaults({ - headers: { - authorization: `token secret123` - } -}) -const { repository } = await graphql(`{ - repository(owner:"octokit", name:"graphql.js") { - issues(last:3) { - edges { - node { - title - } - } - } - } -}`) -``` - -Pass query together with headers and variables - -```js -const graphql = require('@octokit/graphql') +const { graphql } = require('@octokit/graphql') const { lastIssues } = await graphql({ query: `query lastIssues($owner: String!, $repo: String!, $num: Int = 3) { repository(owner:$owner, name:$repo) { @@ -140,26 +182,65 @@ const { lastIssues } = await graphql({ }) ``` -Use with GitHub Enterprise +### Use with GitHub Enterprise ```js -const graphql = require('@octokit/graphql').defaults({ - baseUrl: 'https://github-enterprise.acme-inc.com/api', +let { graphql } = require("@octokit/graphql"); +graphql = graphql.defaults({ + baseUrl: "https://github-enterprise.acme-inc.com/api", headers: { authorization: `token secret123` } -}) -const { repository } = await graphql(`{ - repository(owner:"acme-project", name:"acme-repo") { - issues(last:3) { - edges { - node { - title +}); +const { repository } = await graphql(` + { + repository(owner: "acme-project", name: "acme-repo") { + issues(last: 3) { + edges { + node { + title + } } } } } -}`) +`); +``` + +### Use custom `@octokit/request` instance + +```js +const { request } = require("@octokit/request"); +const { withCustomRequest } = require("@octokit/graphql"); + +let requestCounter = 0 +const myRequest = request.defaults({ + headers: { + authentication: 'token secret123' + }, + request: { + hook(request, options) { + requestCounter++ + return request(options) + } + } +}) +const myGraphql = withCustomRequest(myRequest) +await request('/') +await myGraphql(` + { + repository(owner: "acme-project", name: "acme-repo") { + issues(last: 3) { + edges { + node { + title + } + } + } + } + } +`); +// requestCounter is now 2 ``` ## Errors @@ -167,19 +248,20 @@ const { repository } = await graphql(`{ In case of a GraphQL error, `error.message` is set to the first error from the response’s `errors` array. All errors can be accessed at `error.errors`. `error.request` has the request options such as query, variables and headers set for easier debugging. ```js -const graphql = require('@octokit/graphql').defaults({ +let { graphql } = require("@octokit/graphql"); +graphqlt = graphql.defaults({ headers: { authorization: `token secret123` } -}) +}); const query = `{ viewer { bioHtml } -}` +}`; try { - const result = await graphql(query) + const result = await graphql(query); } catch (error) { // server responds with // { @@ -193,8 +275,8 @@ try { // }] // } - console.log('Request failed:', error.request) // { query, variables: {}, headers: { authorization: 'token secret123' } } - console.log(error.message) // Field 'bioHtml' doesn't exist on type 'User' + console.log("Request failed:", error.request); // { query, variables: {}, headers: { authorization: 'token secret123' } } + console.log(error.message); // Field 'bioHtml' doesn't exist on type 'User' } ``` @@ -203,11 +285,12 @@ try { A GraphQL query may respond with partial data accompanied by errors. In this case we will throw an error but the partial data will still be accessible through `error.data` ```js -const graphql = require('@octokit/graphql').defaults({ +let { graphql } = require("@octokit/graphql"); +graphql = graphql.defaults({ headers: { authorization: `token secret123` } -}) +}); const query = `{ repository(name: "probot", owner: "probot") { name @@ -223,42 +306,42 @@ const query = `{ } } } -}` +}`; try { - const result = await graphql(query) + const result = await graphql(query); } catch (error) { // server responds with - // {  - // "data": {  - // "repository": {  - // "name": "probot",  - // "ref": null  - // }  - // },  - // "errors": [  - // {  - // "type": "INVALID_CURSOR_ARGUMENTS",  - // "path": [  - // "repository",  - // "ref",  - // "target",  - // "history"  - // ],  - // "locations": [  - // {  - // "line": 7,  - // "column": 11  - // }  - // ],  - // "message": "`invalid cursor` does not appear to be a valid cursor."  - // }  - // ]  - // }  + // { + // "data": { + // "repository": { + // "name": "probot", + // "ref": null + // } + // }, + // "errors": [ + // { + // "type": "INVALID_CURSOR_ARGUMENTS", + // "path": [ + // "repository", + // "ref", + // "target", + // "history" + // ], + // "locations": [ + // { + // "line": 7, + // "column": 11 + // } + // ], + // "message": "`invalid cursor` does not appear to be a valid cursor." + // } + // ] + // } - console.log('Request failed:', error.request) // { query, variables: {}, headers: { authorization: 'token secret123' } } - console.log(error.message) // `invalid cursor` does not appear to be a valid cursor. - console.log(error.data) // { repository: { name: 'probot', ref: null } } + console.log("Request failed:", error.request); // { query, variables: {}, headers: { authorization: 'token secret123' } } + console.log(error.message); // `invalid cursor` does not appear to be a valid cursor. + console.log(error.data); // { repository: { name: 'probot', ref: null } } } ``` @@ -267,24 +350,29 @@ try { You can pass a replacement for [the built-in fetch implementation](https://github.com/bitinn/node-fetch) as `request.fetch` option. For example, using [fetch-mock](http://www.wheresrhys.co.uk/fetch-mock/) works great to write tests ```js -const assert = require('assert') -const fetchMock = require('fetch-mock/es5/server') +const assert = require("assert"); +const fetchMock = require("fetch-mock/es5/server"); -const graphql = require('@octokit/graphql') +const { graphql } = require("@octokit/graphql"); -graphql('{ viewer { login } }', { +graphql("{ viewer { login } }", { headers: { - authorization: 'token secret123' + authorization: "token secret123" }, request: { - fetch: fetchMock.sandbox() - .post('https://api.github.com/graphql', (url, options) => { - assert.strictEqual(options.headers.authorization, 'token secret123') - assert.strictEqual(options.body, '{"query":"{ viewer { login } }"}', 'Sends correct query') - return { data: {} } + fetch: fetchMock + .sandbox() + .post("https://api.github.com/graphql", (url, options) => { + assert.strictEqual(options.headers.authorization, "token secret123"); + assert.strictEqual( + options.body, + '{"query":"{ viewer { login } }"}', + "Sends correct query" + ); + return { data: {} }; }) } -}) +}); ``` ## License diff --git a/node_modules/@octokit/graphql/index.js b/node_modules/@octokit/graphql/index.js deleted file mode 100644 index 7f8278c..0000000 --- a/node_modules/@octokit/graphql/index.js +++ /dev/null @@ -1,15 +0,0 @@ -const { request } = require('@octokit/request') -const getUserAgent = require('universal-user-agent') - -const version = require('./package.json').version -const userAgent = `octokit-graphql.js/${version} ${getUserAgent()}` - -const withDefaults = require('./lib/with-defaults') - -module.exports = withDefaults(request, { - method: 'POST', - url: '/graphql', - headers: { - 'user-agent': userAgent - } -}) diff --git a/node_modules/@octokit/graphql/lib/error.js b/node_modules/@octokit/graphql/lib/error.js deleted file mode 100644 index 4478abd..0000000 --- a/node_modules/@octokit/graphql/lib/error.js +++ /dev/null @@ -1,16 +0,0 @@ -module.exports = class GraphqlError extends Error { - constructor (request, response) { - const message = response.data.errors[0].message - super(message) - - Object.assign(this, response.data) - this.name = 'GraphqlError' - this.request = request - - // Maintains proper stack trace (only available on V8) - /* istanbul ignore next */ - if (Error.captureStackTrace) { - Error.captureStackTrace(this, this.constructor) - } - } -} diff --git a/node_modules/@octokit/graphql/lib/graphql.js b/node_modules/@octokit/graphql/lib/graphql.js deleted file mode 100644 index 4a5b211..0000000 --- a/node_modules/@octokit/graphql/lib/graphql.js +++ /dev/null @@ -1,36 +0,0 @@ -module.exports = graphql - -const GraphqlError = require('./error') - -const NON_VARIABLE_OPTIONS = ['method', 'baseUrl', 'url', 'headers', 'request', 'query'] - -function graphql (request, query, options) { - if (typeof query === 'string') { - options = Object.assign({ query }, options) - } else { - options = query - } - - const requestOptions = Object.keys(options).reduce((result, key) => { - if (NON_VARIABLE_OPTIONS.includes(key)) { - result[key] = options[key] - return result - } - - if (!result.variables) { - result.variables = {} - } - - result.variables[key] = options[key] - return result - }, {}) - - return request(requestOptions) - .then(response => { - if (response.data.errors) { - throw new GraphqlError(requestOptions, response) - } - - return response.data.data - }) -} diff --git a/node_modules/@octokit/graphql/lib/with-defaults.js b/node_modules/@octokit/graphql/lib/with-defaults.js deleted file mode 100644 index a5b1493..0000000 --- a/node_modules/@octokit/graphql/lib/with-defaults.js +++ /dev/null @@ -1,13 +0,0 @@ -module.exports = withDefaults - -const graphql = require('./graphql') - -function withDefaults (request, newDefaults) { - const newRequest = request.defaults(newDefaults) - const newApi = function (query, options) { - return graphql(newRequest, query, options) - } - - newApi.defaults = withDefaults.bind(null, newRequest) - return newApi -} diff --git a/node_modules/@octokit/graphql/package.json b/node_modules/@octokit/graphql/package.json index a1afbee..76fcbf5 100644 --- a/node_modules/@octokit/graphql/package.json +++ b/node_modules/@octokit/graphql/package.json @@ -1,67 +1,62 @@ { - "_from": "@octokit/graphql@^2.0.1", - "_id": "@octokit/graphql@2.1.3", + "_args": [ + [ + "@octokit/graphql@4.3.1", + "/Users/marocchino/Documents/sticky-pull-request-comment" + ] + ], + "_from": "@octokit/graphql@4.3.1", + "_id": "@octokit/graphql@4.3.1", "_inBundle": false, - "_integrity": "sha512-XoXJqL2ondwdnMIW3wtqJWEwcBfKk37jO/rYkoxNPEVeLBDGsGO1TCWggrAlq3keGt/O+C/7VepXnukUxwt5vA==", + "_integrity": "sha512-hCdTjfvrK+ilU2keAdqNBWOk+gm1kai1ZcdjRfB30oA3/T6n53UVJb7w0L5cR3/rhU91xT3HSqCd+qbvH06yxA==", "_location": "/@octokit/graphql", "_phantomChildren": {}, "_requested": { - "type": "range", + "type": "version", "registry": true, - "raw": "@octokit/graphql@^2.0.1", + "raw": "@octokit/graphql@4.3.1", "name": "@octokit/graphql", "escapedName": "@octokit%2fgraphql", "scope": "@octokit", - "rawSpec": "^2.0.1", + "rawSpec": "4.3.1", "saveSpec": null, - "fetchSpec": "^2.0.1" + "fetchSpec": "4.3.1" }, "_requiredBy": [ "/@actions/github" ], - "_resolved": "https://registry.npmjs.org/@octokit/graphql/-/graphql-2.1.3.tgz", - "_shasum": "60c058a0ed5fa242eca6f938908d95fd1a2f4b92", - "_spec": "@octokit/graphql@^2.0.1", - "_where": "/Users/shim.taewon/Documents/sticky-pull-request-comment/node_modules/@actions/github", - "author": { - "name": "Gregor Martynus", - "url": "https://github.com/gr2m" - }, + "_resolved": "https://registry.npmjs.org/@octokit/graphql/-/graphql-4.3.1.tgz", + "_spec": "4.3.1", + "_where": "/Users/marocchino/Documents/sticky-pull-request-comment", "bugs": { "url": "https://github.com/octokit/graphql.js/issues" }, - "bundleDependencies": false, - "bundlesize": [ - { - "path": "./dist/octokit-graphql.min.js.gz", - "maxSize": "5KB" - } - ], + "deno": "dist-web/index.js", "dependencies": { - "@octokit/request": "^5.0.0", - "universal-user-agent": "^2.0.3" + "@octokit/request": "^5.3.0", + "@octokit/types": "^2.0.0", + "universal-user-agent": "^4.0.0" }, - "deprecated": false, "description": "GitHub GraphQL API client for browsers and Node", "devDependencies": { - "chai": "^4.2.0", - "compression-webpack-plugin": "^2.0.0", - "coveralls": "^3.0.3", - "cypress": "^3.1.5", + "@pika/pack": "^0.5.0", + "@pika/plugin-build-node": "^0.7.0", + "@pika/plugin-build-web": "^0.7.0", + "@pika/plugin-ts-standard-pkg": "^0.7.0", + "@types/fetch-mock": "^7.2.5", + "@types/jest": "^24.0.13", + "@types/node": "^12.0.2", "fetch-mock": "^7.3.1", - "mkdirp": "^0.5.1", - "mocha": "^6.0.0", - "npm-run-all": "^4.1.3", - "nyc": "^14.0.0", + "jest": "^24.8.0", + "prettier": "^1.17.1", "semantic-release": "^15.13.3", - "simple-mock": "^0.8.0", - "standard": "^12.0.1", - "webpack": "^4.29.6", - "webpack-bundle-analyzer": "^3.1.0", - "webpack-cli": "^3.2.3" + "semantic-release-plugin-update-version-in-files": "^1.0.0", + "ts-jest": "^24.0.2", + "typescript": "^3.4.5" }, "files": [ - "lib" + "dist-*/", + "bin/" ], "homepage": "https://github.com/octokit/graphql.js#readme", "keywords": [ @@ -71,49 +66,18 @@ "graphql" ], "license": "MIT", - "main": "index.js", + "main": "dist-node/index.js", "name": "@octokit/graphql", + "pika": true, "publishConfig": { "access": "public" }, - "release": { - "publish": [ - "@semantic-release/npm", - { - "path": "@semantic-release/github", - "assets": [ - "dist/*", - "!dist/*.map.gz" - ] - } - ] - }, "repository": { "type": "git", "url": "git+https://github.com/octokit/graphql.js.git" }, - "scripts": { - "build": "npm-run-all build:*", - "build:development": "webpack --mode development --entry . --output-library=octokitGraphql --output=./dist/octokit-graphql.js --profile --json > dist/bundle-stats.json", - "build:production": "webpack --mode production --entry . --plugin=compression-webpack-plugin --output-library=octokitGraphql --output-path=./dist --output-filename=octokit-graphql.min.js --devtool source-map", - "bundle-report": "webpack-bundle-analyzer dist/bundle-stats.json --mode=static --no-open --report dist/bundle-report.html", - "coverage": "nyc report --reporter=html && open coverage/index.html", - "coverage:upload": "nyc report --reporter=text-lcov | coveralls", - "prebuild": "mkdirp dist/", - "pretest": "standard", - "test": "nyc mocha test/*-test.js", - "test:browser": "cypress run --browser chrome" - }, - "standard": { - "globals": [ - "describe", - "before", - "beforeEach", - "afterEach", - "after", - "it", - "expect" - ] - }, - "version": "2.1.3" + "sideEffects": false, + "source": "dist-src/index.js", + "types": "dist-types/index.d.ts", + "version": "4.3.1" } diff --git a/node_modules/@octokit/request-error/README.md b/node_modules/@octokit/request-error/README.md index bcb711d..3faf40d 100644 --- a/node_modules/@octokit/request-error/README.md +++ b/node_modules/@octokit/request-error/README.md @@ -3,7 +3,7 @@ > Error class for Octokit request errors [![@latest](https://img.shields.io/npm/v/@octokit/request-error.svg)](https://www.npmjs.com/package/@octokit/request-error) -[![Build Status](https://travis-ci.com/octokit/request-error.js.svg?branch=master)](https://travis-ci.com/octokit/request-error.js) +[![Build Status](https://github.com/octokit/request-error.js/workflows/Test/badge.svg)](https://github.com/octokit/request-error.js/actions?query=workflow%3ATest) [![Greenkeeper](https://badges.greenkeeper.io/octokit/request-error.js.svg)](https://greenkeeper.io/) ## Usage @@ -40,18 +40,18 @@ const { RequestError } = require("@octokit/request-error"); ```js const error = new RequestError("Oops", 500, { headers: { - "x-github-request-id": "1:2:3:4" + "x-github-request-id": "1:2:3:4", }, // response headers request: { method: "POST", url: "https://api.github.com/foo", body: { - bar: "baz" + bar: "baz", }, headers: { - authorization: "token secret123" - } - } + authorization: "token secret123", + }, + }, }); error.message; // Oops diff --git a/node_modules/@octokit/request-error/dist-node/index.js.map b/node_modules/@octokit/request-error/dist-node/index.js.map index ec1c6db..2562006 100644 --- a/node_modules/@octokit/request-error/dist-node/index.js.map +++ b/node_modules/@octokit/request-error/dist-node/index.js.map @@ -1 +1 @@ -{"version":3,"file":"index.js","sources":["../dist-src/index.js"],"sourcesContent":["import { Deprecation } from \"deprecation\";\nimport once from \"once\";\nconst logOnce = once((deprecation) => console.warn(deprecation));\n/**\n * Error with extra properties to help with debugging\n */\nexport class RequestError extends Error {\n constructor(message, statusCode, options) {\n super(message);\n // Maintains proper stack trace (only available on V8)\n /* istanbul ignore next */\n if (Error.captureStackTrace) {\n Error.captureStackTrace(this, this.constructor);\n }\n this.name = \"HttpError\";\n this.status = statusCode;\n Object.defineProperty(this, \"code\", {\n get() {\n logOnce(new Deprecation(\"[@octokit/request-error] `error.code` is deprecated, use `error.status`.\"));\n return statusCode;\n }\n });\n this.headers = options.headers || {};\n // redact request credentials without mutating original request options\n const requestCopy = Object.assign({}, options.request);\n if (options.request.headers.authorization) {\n requestCopy.headers = Object.assign({}, options.request.headers, {\n authorization: options.request.headers.authorization.replace(/ .*$/, \" [REDACTED]\")\n });\n }\n requestCopy.url = requestCopy.url\n // client_id & client_secret can be passed as URL query parameters to increase rate limit\n // see https://developer.github.com/v3/#increasing-the-unauthenticated-rate-limit-for-oauth-applications\n .replace(/\\bclient_secret=\\w+/g, \"client_secret=[REDACTED]\")\n // OAuth tokens can be passed as URL query parameters, although it is not recommended\n // see https://developer.github.com/v3/#oauth2-token-sent-in-a-header\n .replace(/\\baccess_token=\\w+/g, \"access_token=[REDACTED]\");\n this.request = requestCopy;\n }\n}\n"],"names":["logOnce","once","deprecation","console","warn","RequestError","Error","constructor","message","statusCode","options","captureStackTrace","name","status","Object","defineProperty","get","Deprecation","headers","requestCopy","assign","request","authorization","replace","url"],"mappings":";;;;;;;;;AAEA,MAAMA,OAAO,GAAGC,IAAI,CAAEC,WAAD,IAAiBC,OAAO,CAACC,IAAR,CAAaF,WAAb,CAAlB,CAApB;;;;;AAIA,AAAO,MAAMG,YAAN,SAA2BC,KAA3B,CAAiC;EACpCC,WAAW,CAACC,OAAD,EAAUC,UAAV,EAAsBC,OAAtB,EAA+B;UAChCF,OAAN,EADsC;;;;QAIlCF,KAAK,CAACK,iBAAV,EAA6B;MACzBL,KAAK,CAACK,iBAAN,CAAwB,IAAxB,EAA8B,KAAKJ,WAAnC;;;SAECK,IAAL,GAAY,WAAZ;SACKC,MAAL,GAAcJ,UAAd;IACAK,MAAM,CAACC,cAAP,CAAsB,IAAtB,EAA4B,MAA5B,EAAoC;MAChCC,GAAG,GAAG;QACFhB,OAAO,CAAC,IAAIiB,uBAAJ,CAAgB,0EAAhB,CAAD,CAAP;eACOR,UAAP;;;KAHR;SAMKS,OAAL,GAAeR,OAAO,CAACQ,OAAR,IAAmB,EAAlC,CAfsC;;UAiBhCC,WAAW,GAAGL,MAAM,CAACM,MAAP,CAAc,EAAd,EAAkBV,OAAO,CAACW,OAA1B,CAApB;;QACIX,OAAO,CAACW,OAAR,CAAgBH,OAAhB,CAAwBI,aAA5B,EAA2C;MACvCH,WAAW,CAACD,OAAZ,GAAsBJ,MAAM,CAACM,MAAP,CAAc,EAAd,EAAkBV,OAAO,CAACW,OAAR,CAAgBH,OAAlC,EAA2C;QAC7DI,aAAa,EAAEZ,OAAO,CAACW,OAAR,CAAgBH,OAAhB,CAAwBI,aAAxB,CAAsCC,OAAtC,CAA8C,MAA9C,EAAsD,aAAtD;OADG,CAAtB;;;IAIJJ,WAAW,CAACK,GAAZ,GAAkBL,WAAW,CAACK,GAAZ;;KAGbD,OAHa,CAGL,sBAHK,EAGmB,0BAHnB;;KAMbA,OANa,CAML,qBANK,EAMkB,yBANlB,CAAlB;SAOKF,OAAL,GAAeF,WAAf;;;;;;;"} \ No newline at end of file +{"version":3,"file":"index.js","sources":["../dist-src/index.js"],"sourcesContent":["import { Deprecation } from \"deprecation\";\nimport once from \"once\";\nconst logOnce = once((deprecation) => console.warn(deprecation));\n/**\n * Error with extra properties to help with debugging\n */\nexport class RequestError extends Error {\n constructor(message, statusCode, options) {\n super(message);\n // Maintains proper stack trace (only available on V8)\n /* istanbul ignore next */\n if (Error.captureStackTrace) {\n Error.captureStackTrace(this, this.constructor);\n }\n this.name = \"HttpError\";\n this.status = statusCode;\n Object.defineProperty(this, \"code\", {\n get() {\n logOnce(new Deprecation(\"[@octokit/request-error] `error.code` is deprecated, use `error.status`.\"));\n return statusCode;\n },\n });\n this.headers = options.headers || {};\n // redact request credentials without mutating original request options\n const requestCopy = Object.assign({}, options.request);\n if (options.request.headers.authorization) {\n requestCopy.headers = Object.assign({}, options.request.headers, {\n authorization: options.request.headers.authorization.replace(/ .*$/, \" [REDACTED]\"),\n });\n }\n requestCopy.url = requestCopy.url\n // client_id & client_secret can be passed as URL query parameters to increase rate limit\n // see https://developer.github.com/v3/#increasing-the-unauthenticated-rate-limit-for-oauth-applications\n .replace(/\\bclient_secret=\\w+/g, \"client_secret=[REDACTED]\")\n // OAuth tokens can be passed as URL query parameters, although it is not recommended\n // see https://developer.github.com/v3/#oauth2-token-sent-in-a-header\n .replace(/\\baccess_token=\\w+/g, \"access_token=[REDACTED]\");\n this.request = requestCopy;\n }\n}\n"],"names":["logOnce","once","deprecation","console","warn","RequestError","Error","constructor","message","statusCode","options","captureStackTrace","name","status","Object","defineProperty","get","Deprecation","headers","requestCopy","assign","request","authorization","replace","url"],"mappings":";;;;;;;;;AAEA,MAAMA,OAAO,GAAGC,IAAI,CAAEC,WAAD,IAAiBC,OAAO,CAACC,IAAR,CAAaF,WAAb,CAAlB,CAApB;AACA;;;;AAGO,MAAMG,YAAN,SAA2BC,KAA3B,CAAiC;AACpCC,EAAAA,WAAW,CAACC,OAAD,EAAUC,UAAV,EAAsBC,OAAtB,EAA+B;AACtC,UAAMF,OAAN,EADsC;;AAGtC;;AACA,QAAIF,KAAK,CAACK,iBAAV,EAA6B;AACzBL,MAAAA,KAAK,CAACK,iBAAN,CAAwB,IAAxB,EAA8B,KAAKJ,WAAnC;AACH;;AACD,SAAKK,IAAL,GAAY,WAAZ;AACA,SAAKC,MAAL,GAAcJ,UAAd;AACAK,IAAAA,MAAM,CAACC,cAAP,CAAsB,IAAtB,EAA4B,MAA5B,EAAoC;AAChCC,MAAAA,GAAG,GAAG;AACFhB,QAAAA,OAAO,CAAC,IAAIiB,uBAAJ,CAAgB,0EAAhB,CAAD,CAAP;AACA,eAAOR,UAAP;AACH;;AAJ+B,KAApC;AAMA,SAAKS,OAAL,GAAeR,OAAO,CAACQ,OAAR,IAAmB,EAAlC,CAfsC;;AAiBtC,UAAMC,WAAW,GAAGL,MAAM,CAACM,MAAP,CAAc,EAAd,EAAkBV,OAAO,CAACW,OAA1B,CAApB;;AACA,QAAIX,OAAO,CAACW,OAAR,CAAgBH,OAAhB,CAAwBI,aAA5B,EAA2C;AACvCH,MAAAA,WAAW,CAACD,OAAZ,GAAsBJ,MAAM,CAACM,MAAP,CAAc,EAAd,EAAkBV,OAAO,CAACW,OAAR,CAAgBH,OAAlC,EAA2C;AAC7DI,QAAAA,aAAa,EAAEZ,OAAO,CAACW,OAAR,CAAgBH,OAAhB,CAAwBI,aAAxB,CAAsCC,OAAtC,CAA8C,MAA9C,EAAsD,aAAtD;AAD8C,OAA3C,CAAtB;AAGH;;AACDJ,IAAAA,WAAW,CAACK,GAAZ,GAAkBL,WAAW,CAACK,GAAZ;AAEd;AAFc,KAGbD,OAHa,CAGL,sBAHK,EAGmB,0BAHnB;AAKd;AALc,KAMbA,OANa,CAML,qBANK,EAMkB,yBANlB,CAAlB;AAOA,SAAKF,OAAL,GAAeF,WAAf;AACH;;AAhCmC;;;;"} \ No newline at end of file diff --git a/node_modules/@octokit/request-error/dist-src/index.js b/node_modules/@octokit/request-error/dist-src/index.js index cfcb7c4..c880b45 100644 --- a/node_modules/@octokit/request-error/dist-src/index.js +++ b/node_modules/@octokit/request-error/dist-src/index.js @@ -18,14 +18,14 @@ export class RequestError extends Error { get() { logOnce(new Deprecation("[@octokit/request-error] `error.code` is deprecated, use `error.status`.")); return statusCode; - } + }, }); this.headers = options.headers || {}; // redact request credentials without mutating original request options const requestCopy = Object.assign({}, options.request); if (options.request.headers.authorization) { requestCopy.headers = Object.assign({}, options.request.headers, { - authorization: options.request.headers.authorization.replace(/ .*$/, " [REDACTED]") + authorization: options.request.headers.authorization.replace(/ .*$/, " [REDACTED]"), }); } requestCopy.url = requestCopy.url diff --git a/node_modules/@octokit/request-error/dist-web/index.js b/node_modules/@octokit/request-error/dist-web/index.js index 32b45a3..feec58e 100644 --- a/node_modules/@octokit/request-error/dist-web/index.js +++ b/node_modules/@octokit/request-error/dist-web/index.js @@ -19,14 +19,14 @@ class RequestError extends Error { get() { logOnce(new Deprecation("[@octokit/request-error] `error.code` is deprecated, use `error.status`.")); return statusCode; - } + }, }); this.headers = options.headers || {}; // redact request credentials without mutating original request options const requestCopy = Object.assign({}, options.request); if (options.request.headers.authorization) { requestCopy.headers = Object.assign({}, options.request.headers, { - authorization: options.request.headers.authorization.replace(/ .*$/, " [REDACTED]") + authorization: options.request.headers.authorization.replace(/ .*$/, " [REDACTED]"), }); } requestCopy.url = requestCopy.url diff --git a/node_modules/@octokit/request-error/dist-web/index.js.map b/node_modules/@octokit/request-error/dist-web/index.js.map index 05151b0..130740d 100644 --- a/node_modules/@octokit/request-error/dist-web/index.js.map +++ b/node_modules/@octokit/request-error/dist-web/index.js.map @@ -1 +1 @@ -{"version":3,"file":"index.js","sources":["../dist-src/index.js"],"sourcesContent":["import { Deprecation } from \"deprecation\";\nimport once from \"once\";\nconst logOnce = once((deprecation) => console.warn(deprecation));\n/**\n * Error with extra properties to help with debugging\n */\nexport class RequestError extends Error {\n constructor(message, statusCode, options) {\n super(message);\n // Maintains proper stack trace (only available on V8)\n /* istanbul ignore next */\n if (Error.captureStackTrace) {\n Error.captureStackTrace(this, this.constructor);\n }\n this.name = \"HttpError\";\n this.status = statusCode;\n Object.defineProperty(this, \"code\", {\n get() {\n logOnce(new Deprecation(\"[@octokit/request-error] `error.code` is deprecated, use `error.status`.\"));\n return statusCode;\n }\n });\n this.headers = options.headers || {};\n // redact request credentials without mutating original request options\n const requestCopy = Object.assign({}, options.request);\n if (options.request.headers.authorization) {\n requestCopy.headers = Object.assign({}, options.request.headers, {\n authorization: options.request.headers.authorization.replace(/ .*$/, \" [REDACTED]\")\n });\n }\n requestCopy.url = requestCopy.url\n // client_id & client_secret can be passed as URL query parameters to increase rate limit\n // see https://developer.github.com/v3/#increasing-the-unauthenticated-rate-limit-for-oauth-applications\n .replace(/\\bclient_secret=\\w+/g, \"client_secret=[REDACTED]\")\n // OAuth tokens can be passed as URL query parameters, although it is not recommended\n // see https://developer.github.com/v3/#oauth2-token-sent-in-a-header\n .replace(/\\baccess_token=\\w+/g, \"access_token=[REDACTED]\");\n this.request = requestCopy;\n }\n}\n"],"names":[],"mappings":";;;AAEA,MAAM,OAAO,GAAG,IAAI,CAAC,CAAC,WAAW,KAAK,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;;;;AAIjE,AAAO,MAAM,YAAY,SAAS,KAAK,CAAC;IACpC,WAAW,CAAC,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE;QACtC,KAAK,CAAC,OAAO,CAAC,CAAC;;;QAGf,IAAI,KAAK,CAAC,iBAAiB,EAAE;YACzB,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;SACnD;QACD,IAAI,CAAC,IAAI,GAAG,WAAW,CAAC;QACxB,IAAI,CAAC,MAAM,GAAG,UAAU,CAAC;QACzB,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE;YAChC,GAAG,GAAG;gBACF,OAAO,CAAC,IAAI,WAAW,CAAC,0EAA0E,CAAC,CAAC,CAAC;gBACrG,OAAO,UAAU,CAAC;aACrB;SACJ,CAAC,CAAC;QACH,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,EAAE,CAAC;;QAErC,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;QACvD,IAAI,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,aAAa,EAAE;YACvC,WAAW,CAAC,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,OAAO,CAAC,OAAO,CAAC,OAAO,EAAE;gBAC7D,aAAa,EAAE,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,MAAM,EAAE,aAAa,CAAC;aACtF,CAAC,CAAC;SACN;QACD,WAAW,CAAC,GAAG,GAAG,WAAW,CAAC,GAAG;;;aAG5B,OAAO,CAAC,sBAAsB,EAAE,0BAA0B,CAAC;;;aAG3D,OAAO,CAAC,qBAAqB,EAAE,yBAAyB,CAAC,CAAC;QAC/D,IAAI,CAAC,OAAO,GAAG,WAAW,CAAC;KAC9B;CACJ;;;;"} \ No newline at end of file +{"version":3,"file":"index.js","sources":["../dist-src/index.js"],"sourcesContent":["import { Deprecation } from \"deprecation\";\nimport once from \"once\";\nconst logOnce = once((deprecation) => console.warn(deprecation));\n/**\n * Error with extra properties to help with debugging\n */\nexport class RequestError extends Error {\n constructor(message, statusCode, options) {\n super(message);\n // Maintains proper stack trace (only available on V8)\n /* istanbul ignore next */\n if (Error.captureStackTrace) {\n Error.captureStackTrace(this, this.constructor);\n }\n this.name = \"HttpError\";\n this.status = statusCode;\n Object.defineProperty(this, \"code\", {\n get() {\n logOnce(new Deprecation(\"[@octokit/request-error] `error.code` is deprecated, use `error.status`.\"));\n return statusCode;\n },\n });\n this.headers = options.headers || {};\n // redact request credentials without mutating original request options\n const requestCopy = Object.assign({}, options.request);\n if (options.request.headers.authorization) {\n requestCopy.headers = Object.assign({}, options.request.headers, {\n authorization: options.request.headers.authorization.replace(/ .*$/, \" [REDACTED]\"),\n });\n }\n requestCopy.url = requestCopy.url\n // client_id & client_secret can be passed as URL query parameters to increase rate limit\n // see https://developer.github.com/v3/#increasing-the-unauthenticated-rate-limit-for-oauth-applications\n .replace(/\\bclient_secret=\\w+/g, \"client_secret=[REDACTED]\")\n // OAuth tokens can be passed as URL query parameters, although it is not recommended\n // see https://developer.github.com/v3/#oauth2-token-sent-in-a-header\n .replace(/\\baccess_token=\\w+/g, \"access_token=[REDACTED]\");\n this.request = requestCopy;\n }\n}\n"],"names":[],"mappings":";;;AAEA,MAAM,OAAO,GAAG,IAAI,CAAC,CAAC,WAAW,KAAK,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;AACjE;AACA;AACA;AACO,MAAM,YAAY,SAAS,KAAK,CAAC;AACxC,IAAI,WAAW,CAAC,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE;AAC9C,QAAQ,KAAK,CAAC,OAAO,CAAC,CAAC;AACvB;AACA;AACA,QAAQ,IAAI,KAAK,CAAC,iBAAiB,EAAE;AACrC,YAAY,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;AAC5D,SAAS;AACT,QAAQ,IAAI,CAAC,IAAI,GAAG,WAAW,CAAC;AAChC,QAAQ,IAAI,CAAC,MAAM,GAAG,UAAU,CAAC;AACjC,QAAQ,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE;AAC5C,YAAY,GAAG,GAAG;AAClB,gBAAgB,OAAO,CAAC,IAAI,WAAW,CAAC,0EAA0E,CAAC,CAAC,CAAC;AACrH,gBAAgB,OAAO,UAAU,CAAC;AAClC,aAAa;AACb,SAAS,CAAC,CAAC;AACX,QAAQ,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,EAAE,CAAC;AAC7C;AACA,QAAQ,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;AAC/D,QAAQ,IAAI,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,aAAa,EAAE;AACnD,YAAY,WAAW,CAAC,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,OAAO,CAAC,OAAO,CAAC,OAAO,EAAE;AAC7E,gBAAgB,aAAa,EAAE,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,MAAM,EAAE,aAAa,CAAC;AACnG,aAAa,CAAC,CAAC;AACf,SAAS;AACT,QAAQ,WAAW,CAAC,GAAG,GAAG,WAAW,CAAC,GAAG;AACzC;AACA;AACA,aAAa,OAAO,CAAC,sBAAsB,EAAE,0BAA0B,CAAC;AACxE;AACA;AACA,aAAa,OAAO,CAAC,qBAAqB,EAAE,yBAAyB,CAAC,CAAC;AACvE,QAAQ,IAAI,CAAC,OAAO,GAAG,WAAW,CAAC;AACnC,KAAK;AACL;;;;"} \ No newline at end of file diff --git a/node_modules/@octokit/request-error/package.json b/node_modules/@octokit/request-error/package.json index 96e9055..2f1f78e 100644 --- a/node_modules/@octokit/request-error/package.json +++ b/node_modules/@octokit/request-error/package.json @@ -1,55 +1,56 @@ { - "_from": "@octokit/request-error@^1.0.1", - "_id": "@octokit/request-error@1.2.0", + "_args": [ + [ + "@octokit/request-error@2.0.0", + "/Users/marocchino/Documents/sticky-pull-request-comment" + ] + ], + "_from": "@octokit/request-error@2.0.0", + "_id": "@octokit/request-error@2.0.0", "_inBundle": false, - "_integrity": "sha512-DNBhROBYjjV/I9n7A8kVkmQNkqFAMem90dSxqvPq57e2hBr7mNTX98y3R2zDpqMQHVRpBDjsvsfIGgBzy+4PAg==", + "_integrity": "sha512-rtYicB4Absc60rUv74Rjpzek84UbVHGHJRu4fNVlZ1mCcyUPPuzFfG9Rn6sjHrd95DEsmjSt1Axlc699ZlbDkw==", "_location": "/@octokit/request-error", "_phantomChildren": {}, "_requested": { - "type": "range", + "type": "version", "registry": true, - "raw": "@octokit/request-error@^1.0.1", + "raw": "@octokit/request-error@2.0.0", "name": "@octokit/request-error", "escapedName": "@octokit%2frequest-error", "scope": "@octokit", - "rawSpec": "^1.0.1", + "rawSpec": "2.0.0", "saveSpec": null, - "fetchSpec": "^1.0.1" + "fetchSpec": "2.0.0" }, "_requiredBy": [ - "/@octokit/request", - "/@octokit/rest" + "/@octokit/request" ], - "_resolved": "https://registry.npmjs.org/@octokit/request-error/-/request-error-1.2.0.tgz", - "_shasum": "a64d2a9d7a13555570cd79722de4a4d76371baaa", - "_spec": "@octokit/request-error@^1.0.1", - "_where": "/Users/shim.taewon/Documents/sticky-pull-request-comment/node_modules/@octokit/request", + "_resolved": "https://registry.npmjs.org/@octokit/request-error/-/request-error-2.0.0.tgz", + "_spec": "2.0.0", + "_where": "/Users/marocchino/Documents/sticky-pull-request-comment", "bugs": { "url": "https://github.com/octokit/request-error.js/issues" }, - "bundleDependencies": false, - "deno": "dist-web/index.js", "dependencies": { "@octokit/types": "^2.0.0", "deprecation": "^2.0.0", "once": "^1.4.0" }, - "deprecated": false, "description": "Error class for Octokit request errors", "devDependencies": { "@pika/pack": "^0.5.0", - "@pika/plugin-build-node": "^0.7.0", - "@pika/plugin-build-web": "^0.7.0", - "@pika/plugin-bundle-web": "^0.7.0", - "@pika/plugin-ts-standard-pkg": "^0.7.0", - "@types/jest": "^24.0.12", - "@types/node": "^12.0.2", + "@pika/plugin-build-node": "^0.9.0", + "@pika/plugin-build-web": "^0.9.0", + "@pika/plugin-bundle-web": "^0.9.0", + "@pika/plugin-ts-standard-pkg": "^0.9.0", + "@types/jest": "^25.1.0", + "@types/node": "^13.1.0", "@types/once": "^1.4.0", - "jest": "^24.7.1", + "jest": "^25.1.0", "pika-plugin-unpkg-field": "^1.1.0", - "prettier": "^1.17.0", - "semantic-release": "^15.10.5", - "ts-jest": "^24.0.2", + "prettier": "^2.0.1", + "semantic-release": "^17.0.0", + "ts-jest": "^25.1.0", "typescript": "^3.4.5" }, "files": [ @@ -65,6 +66,7 @@ ], "license": "MIT", "main": "dist-node/index.js", + "module": "dist-web/index.js", "name": "@octokit/request-error", "pika": true, "publishConfig": { @@ -77,5 +79,5 @@ "sideEffects": false, "source": "dist-src/index.js", "types": "dist-types/index.d.ts", - "version": "1.2.0" + "version": "2.0.0" } diff --git a/node_modules/@octokit/request/README.md b/node_modules/@octokit/request/README.md index db35e62..c95104f 100644 --- a/node_modules/@octokit/request/README.md +++ b/node_modules/@octokit/request/README.md @@ -3,7 +3,7 @@ > Send parameterized requests to GitHub’s APIs with sensible defaults in browsers and Node [![@latest](https://img.shields.io/npm/v/@octokit/request.svg)](https://www.npmjs.com/package/@octokit/request) -[![Build Status](https://travis-ci.org/octokit/request.js.svg?branch=master)](https://travis-ci.org/octokit/request.js) +[![Build Status](https://github.com/octokit/request.js/workflows/Test/badge.svg)](https://github.com/octokit/request.js/actions?query=workflow%3ATest) [![Greenkeeper](https://badges.greenkeeper.io/octokit/request.js.svg)](https://greenkeeper.io/) `@octokit/request` is a request library for browsers & node that makes it easier @@ -41,12 +41,12 @@ the passed options and sends the request using [fetch](https://developer.mozilla ```js request("POST /repos/:owner/:repo/issues/:number/labels", { mediaType: { - previews: ["symmetra"] + previews: ["symmetra"], }, owner: "octokit", repo: "request.js", number: 1, - labels: ["🐛 bug"] + labels: ["🐛 bug"], }); ``` @@ -102,10 +102,10 @@ const { request } = require("@octokit/request"); // https://developer.github.com/v3/repos/#list-organization-repositories const result = await request("GET /orgs/:org/repos", { headers: { - authorization: "token 0000000000000000000000000000000000000001" + authorization: "token 0000000000000000000000000000000000000001", }, org: "octokit", - type: "private" + type: "private", }); console.log(`${result.data.length} repos found.`); @@ -118,7 +118,7 @@ For GraphQL request we recommend using [`@octokit/graphql`](https://github.com/o ```js const result = await request("POST /graphql", { headers: { - authorization: "token 0000000000000000000000000000000000000001" + authorization: "token 0000000000000000000000000000000000000001", }, query: `query ($login: String!) { organization(login: $login) { @@ -128,8 +128,8 @@ const result = await request("POST /graphql", { } }`, variables: { - login: "octokit" - } + login: "octokit", + }, }); ``` @@ -142,10 +142,10 @@ const result = await request({ method: "GET", url: "/orgs/:org/repos", headers: { - authorization: "token 0000000000000000000000000000000000000001" + authorization: "token 0000000000000000000000000000000000000001", }, org: "octokit", - type: "private" + type: "private", }); ``` @@ -156,8 +156,8 @@ The simplest way to authenticate a request is to set the `Authorization` header ```js const requestWithAuth = request.defaults({ headers: { - authorization: "token 0000000000000000000000000000000000000001" - } + authorization: "token 0000000000000000000000000000000000000001", + }, }); const result = await request("GET /user"); ``` @@ -169,22 +169,22 @@ const { createAppAuth } = require("@octokit/auth-app"); const auth = createAppAuth({ id: process.env.APP_ID, privateKey: process.env.PRIVATE_KEY, - installationId: 123 + installationId: 123, }); const requestWithAuth = request.defaults({ request: { - hook: auth.hook + hook: auth.hook, }, mediaType: { - previews: ["machine-man"] - } + previews: ["machine-man"], + }, }); const { data: app } = await requestWithAuth("GET /app"); const { data: app } = await requestWithAuth("POST /repos/:owner/:repo/issues", { owner: "octocat", repo: "hello-world", - title: "Hello from the engine room" + title: "Hello from the engine room", }); ``` @@ -416,10 +416,10 @@ const myrequest = require("@octokit/request").defaults({ baseUrl: "https://github-enterprise.acme-inc.com/api/v3", headers: { "user-agent": "myApp/1.2.3", - authorization: `token 0000000000000000000000000000000000000001` + authorization: `token 0000000000000000000000000000000000000001`, }, org: "my-project", - per_page: 100 + per_page: 100, }); myrequest(`GET /orgs/:org/repos`); @@ -431,14 +431,14 @@ You can call `.defaults()` again on the returned method, the defaults will casca const myProjectRequest = request.defaults({ baseUrl: "https://github-enterprise.acme-inc.com/api/v3", headers: { - "user-agent": "myApp/1.2.3" + "user-agent": "myApp/1.2.3", }, - org: "my-project" + org: "my-project", }); const myProjectRequestWithAuth = myProjectRequest.defaults({ headers: { - authorization: `token 0000000000000000000000000000000000000001` - } + authorization: `token 0000000000000000000000000000000000000001`, + }, }); ``` @@ -453,7 +453,7 @@ See https://github.com/octokit/endpoint.js. Example ```js const options = request.endpoint("GET /orgs/:org/repos", { org: "my-project", - type: "private" + type: "private", }); // { @@ -487,8 +487,8 @@ const response = await request("POST /markdown/raw", { data: "Hello world github/linguist#1 **cool**, and #1!", headers: { accept: "text/html;charset=utf-8", - "content-type": "text/plain" - } + "content-type": "text/plain", + }, }); // Request is sent as @@ -527,9 +527,9 @@ request( headers: { "content-type": "text/plain", "content-length": 14, - authorization: `token 0000000000000000000000000000000000000001` + authorization: `token 0000000000000000000000000000000000000001`, }, - data: "Hello, world!" + data: "Hello, world!", } ); ``` diff --git a/node_modules/@octokit/request/dist-node/index.js b/node_modules/@octokit/request/dist-node/index.js index 19b227b..6904c6d 100644 --- a/node_modules/@octokit/request/dist-node/index.js +++ b/node_modules/@octokit/request/dist-node/index.js @@ -10,7 +10,7 @@ var isPlainObject = _interopDefault(require('is-plain-object')); var nodeFetch = _interopDefault(require('node-fetch')); var requestError = require('@octokit/request-error'); -const VERSION = "5.3.1"; +const VERSION = "5.4.2"; function getBufferResponse(response) { return response.arrayBuffer(); @@ -40,7 +40,7 @@ function fetchWrapper(requestOptions) { if (status === 204 || status === 205) { return; - } // GitHub API returns 200 for HEAD requsets + } // GitHub API returns 200 for HEAD requests if (requestOptions.method === "HEAD") { @@ -71,7 +71,7 @@ function fetchWrapper(requestOptions) { try { let responseBody = JSON.parse(error.message); Object.assign(error, responseBody); - let errors = responseBody.errors; // Assumption `errors` would always be in Array Fotmat + let errors = responseBody.errors; // Assumption `errors` would always be in Array format error.message = error.message + ": " + errors.map(JSON.stringify).join(", "); } catch (e) {// ignore, see octokit/rest.js#684 diff --git a/node_modules/@octokit/request/dist-node/index.js.map b/node_modules/@octokit/request/dist-node/index.js.map index b0ffb70..4325eab 100644 --- a/node_modules/@octokit/request/dist-node/index.js.map +++ b/node_modules/@octokit/request/dist-node/index.js.map @@ -1 +1 @@ -{"version":3,"file":"index.js","sources":["../dist-src/version.js","../dist-src/get-buffer-response.js","../dist-src/fetch-wrapper.js","../dist-src/with-defaults.js","../dist-src/index.js"],"sourcesContent":["export const VERSION = \"5.3.1\";\n","export default function getBufferResponse(response) {\n return response.arrayBuffer();\n}\n","import isPlainObject from \"is-plain-object\";\nimport nodeFetch from \"node-fetch\";\nimport { RequestError } from \"@octokit/request-error\";\nimport getBuffer from \"./get-buffer-response\";\nexport default function fetchWrapper(requestOptions) {\n if (isPlainObject(requestOptions.body) ||\n Array.isArray(requestOptions.body)) {\n requestOptions.body = JSON.stringify(requestOptions.body);\n }\n let headers = {};\n let status;\n let url;\n const fetch = (requestOptions.request && requestOptions.request.fetch) || nodeFetch;\n return fetch(requestOptions.url, Object.assign({\n method: requestOptions.method,\n body: requestOptions.body,\n headers: requestOptions.headers,\n redirect: requestOptions.redirect\n }, requestOptions.request))\n .then(response => {\n url = response.url;\n status = response.status;\n for (const keyAndValue of response.headers) {\n headers[keyAndValue[0]] = keyAndValue[1];\n }\n if (status === 204 || status === 205) {\n return;\n }\n // GitHub API returns 200 for HEAD requsets\n if (requestOptions.method === \"HEAD\") {\n if (status < 400) {\n return;\n }\n throw new RequestError(response.statusText, status, {\n headers,\n request: requestOptions\n });\n }\n if (status === 304) {\n throw new RequestError(\"Not modified\", status, {\n headers,\n request: requestOptions\n });\n }\n if (status >= 400) {\n return response\n .text()\n .then(message => {\n const error = new RequestError(message, status, {\n headers,\n request: requestOptions\n });\n try {\n let responseBody = JSON.parse(error.message);\n Object.assign(error, responseBody);\n let errors = responseBody.errors;\n // Assumption `errors` would always be in Array Fotmat\n error.message =\n error.message + \": \" + errors.map(JSON.stringify).join(\", \");\n }\n catch (e) {\n // ignore, see octokit/rest.js#684\n }\n throw error;\n });\n }\n const contentType = response.headers.get(\"content-type\");\n if (/application\\/json/.test(contentType)) {\n return response.json();\n }\n if (!contentType || /^text\\/|charset=utf-8$/.test(contentType)) {\n return response.text();\n }\n return getBuffer(response);\n })\n .then(data => {\n return {\n status,\n url,\n headers,\n data\n };\n })\n .catch(error => {\n if (error instanceof RequestError) {\n throw error;\n }\n throw new RequestError(error.message, 500, {\n headers,\n request: requestOptions\n });\n });\n}\n","import fetchWrapper from \"./fetch-wrapper\";\nexport default function withDefaults(oldEndpoint, newDefaults) {\n const endpoint = oldEndpoint.defaults(newDefaults);\n const newApi = function (route, parameters) {\n const endpointOptions = endpoint.merge(route, parameters);\n if (!endpointOptions.request || !endpointOptions.request.hook) {\n return fetchWrapper(endpoint.parse(endpointOptions));\n }\n const request = (route, parameters) => {\n return fetchWrapper(endpoint.parse(endpoint.merge(route, parameters)));\n };\n Object.assign(request, {\n endpoint,\n defaults: withDefaults.bind(null, endpoint)\n });\n return endpointOptions.request.hook(request, endpointOptions);\n };\n return Object.assign(newApi, {\n endpoint,\n defaults: withDefaults.bind(null, endpoint)\n });\n}\n","import { endpoint } from \"@octokit/endpoint\";\nimport { getUserAgent } from \"universal-user-agent\";\nimport { VERSION } from \"./version\";\nimport withDefaults from \"./with-defaults\";\nexport const request = withDefaults(endpoint, {\n headers: {\n \"user-agent\": `octokit-request.js/${VERSION} ${getUserAgent()}`\n }\n});\n"],"names":["VERSION","getBufferResponse","response","arrayBuffer","fetchWrapper","requestOptions","isPlainObject","body","Array","isArray","JSON","stringify","headers","status","url","fetch","request","nodeFetch","Object","assign","method","redirect","then","keyAndValue","RequestError","statusText","text","message","error","responseBody","parse","errors","map","join","e","contentType","get","test","json","getBuffer","data","catch","withDefaults","oldEndpoint","newDefaults","endpoint","defaults","newApi","route","parameters","endpointOptions","merge","hook","bind","getUserAgent"],"mappings":";;;;;;;;;;;;AAAO,MAAMA,OAAO,GAAG,mBAAhB;;ACAQ,SAASC,iBAAT,CAA2BC,QAA3B,EAAqC;SACzCA,QAAQ,CAACC,WAAT,EAAP;;;ACGW,SAASC,YAAT,CAAsBC,cAAtB,EAAsC;MAC7CC,aAAa,CAACD,cAAc,CAACE,IAAhB,CAAb,IACAC,KAAK,CAACC,OAAN,CAAcJ,cAAc,CAACE,IAA7B,CADJ,EACwC;IACpCF,cAAc,CAACE,IAAf,GAAsBG,IAAI,CAACC,SAAL,CAAeN,cAAc,CAACE,IAA9B,CAAtB;;;MAEAK,OAAO,GAAG,EAAd;MACIC,MAAJ;MACIC,GAAJ;QACMC,KAAK,GAAIV,cAAc,CAACW,OAAf,IAA0BX,cAAc,CAACW,OAAf,CAAuBD,KAAlD,IAA4DE,SAA1E;SACOF,KAAK,CAACV,cAAc,CAACS,GAAhB,EAAqBI,MAAM,CAACC,MAAP,CAAc;IAC3CC,MAAM,EAAEf,cAAc,CAACe,MADoB;IAE3Cb,IAAI,EAAEF,cAAc,CAACE,IAFsB;IAG3CK,OAAO,EAAEP,cAAc,CAACO,OAHmB;IAI3CS,QAAQ,EAAEhB,cAAc,CAACgB;GAJI,EAK9BhB,cAAc,CAACW,OALe,CAArB,CAAL,CAMFM,IANE,CAMGpB,QAAQ,IAAI;IAClBY,GAAG,GAAGZ,QAAQ,CAACY,GAAf;IACAD,MAAM,GAAGX,QAAQ,CAACW,MAAlB;;SACK,MAAMU,WAAX,IAA0BrB,QAAQ,CAACU,OAAnC,EAA4C;MACxCA,OAAO,CAACW,WAAW,CAAC,CAAD,CAAZ,CAAP,GAA0BA,WAAW,CAAC,CAAD,CAArC;;;QAEAV,MAAM,KAAK,GAAX,IAAkBA,MAAM,KAAK,GAAjC,EAAsC;;KANpB;;;QAUdR,cAAc,CAACe,MAAf,KAA0B,MAA9B,EAAsC;UAC9BP,MAAM,GAAG,GAAb,EAAkB;;;;YAGZ,IAAIW,yBAAJ,CAAiBtB,QAAQ,CAACuB,UAA1B,EAAsCZ,MAAtC,EAA8C;QAChDD,OADgD;QAEhDI,OAAO,EAAEX;OAFP,CAAN;;;QAKAQ,MAAM,KAAK,GAAf,EAAoB;YACV,IAAIW,yBAAJ,CAAiB,cAAjB,EAAiCX,MAAjC,EAAyC;QAC3CD,OAD2C;QAE3CI,OAAO,EAAEX;OAFP,CAAN;;;QAKAQ,MAAM,IAAI,GAAd,EAAmB;aACRX,QAAQ,CACVwB,IADE,GAEFJ,IAFE,CAEGK,OAAO,IAAI;cACXC,KAAK,GAAG,IAAIJ,yBAAJ,CAAiBG,OAAjB,EAA0Bd,MAA1B,EAAkC;UAC5CD,OAD4C;UAE5CI,OAAO,EAAEX;SAFC,CAAd;;YAII;cACIwB,YAAY,GAAGnB,IAAI,CAACoB,KAAL,CAAWF,KAAK,CAACD,OAAjB,CAAnB;UACAT,MAAM,CAACC,MAAP,CAAcS,KAAd,EAAqBC,YAArB;cACIE,MAAM,GAAGF,YAAY,CAACE,MAA1B,CAHA;;UAKAH,KAAK,CAACD,OAAN,GACIC,KAAK,CAACD,OAAN,GAAgB,IAAhB,GAAuBI,MAAM,CAACC,GAAP,CAAWtB,IAAI,CAACC,SAAhB,EAA2BsB,IAA3B,CAAgC,IAAhC,CAD3B;SALJ,CAQA,OAAOC,CAAP,EAAU;;;cAGJN,KAAN;OAlBG,CAAP;;;UAqBEO,WAAW,GAAGjC,QAAQ,CAACU,OAAT,CAAiBwB,GAAjB,CAAqB,cAArB,CAApB;;QACI,oBAAoBC,IAApB,CAAyBF,WAAzB,CAAJ,EAA2C;aAChCjC,QAAQ,CAACoC,IAAT,EAAP;;;QAEA,CAACH,WAAD,IAAgB,yBAAyBE,IAAzB,CAA8BF,WAA9B,CAApB,EAAgE;aACrDjC,QAAQ,CAACwB,IAAT,EAAP;;;WAEGa,iBAAS,CAACrC,QAAD,CAAhB;GA5DG,EA8DFoB,IA9DE,CA8DGkB,IAAI,IAAI;WACP;MACH3B,MADG;MAEHC,GAFG;MAGHF,OAHG;MAIH4B;KAJJ;GA/DG,EAsEFC,KAtEE,CAsEIb,KAAK,IAAI;QACZA,KAAK,YAAYJ,yBAArB,EAAmC;YACzBI,KAAN;;;UAEE,IAAIJ,yBAAJ,CAAiBI,KAAK,CAACD,OAAvB,EAAgC,GAAhC,EAAqC;MACvCf,OADuC;MAEvCI,OAAO,EAAEX;KAFP,CAAN;GA1EG,CAAP;;;ACZW,SAASqC,YAAT,CAAsBC,WAAtB,EAAmCC,WAAnC,EAAgD;QACrDC,QAAQ,GAAGF,WAAW,CAACG,QAAZ,CAAqBF,WAArB,CAAjB;;QACMG,MAAM,GAAG,UAAUC,KAAV,EAAiBC,UAAjB,EAA6B;UAClCC,eAAe,GAAGL,QAAQ,CAACM,KAAT,CAAeH,KAAf,EAAsBC,UAAtB,CAAxB;;QACI,CAACC,eAAe,CAAClC,OAAjB,IAA4B,CAACkC,eAAe,CAAClC,OAAhB,CAAwBoC,IAAzD,EAA+D;aACpDhD,YAAY,CAACyC,QAAQ,CAACf,KAAT,CAAeoB,eAAf,CAAD,CAAnB;;;UAEElC,OAAO,GAAG,CAACgC,KAAD,EAAQC,UAAR,KAAuB;aAC5B7C,YAAY,CAACyC,QAAQ,CAACf,KAAT,CAAee,QAAQ,CAACM,KAAT,CAAeH,KAAf,EAAsBC,UAAtB,CAAf,CAAD,CAAnB;KADJ;;IAGA/B,MAAM,CAACC,MAAP,CAAcH,OAAd,EAAuB;MACnB6B,QADmB;MAEnBC,QAAQ,EAAEJ,YAAY,CAACW,IAAb,CAAkB,IAAlB,EAAwBR,QAAxB;KAFd;WAIOK,eAAe,CAAClC,OAAhB,CAAwBoC,IAAxB,CAA6BpC,OAA7B,EAAsCkC,eAAtC,CAAP;GAZJ;;SAcOhC,MAAM,CAACC,MAAP,CAAc4B,MAAd,EAAsB;IACzBF,QADyB;IAEzBC,QAAQ,EAAEJ,YAAY,CAACW,IAAb,CAAkB,IAAlB,EAAwBR,QAAxB;GAFP,CAAP;;;MCbS7B,OAAO,GAAG0B,YAAY,CAACG,iBAAD,EAAW;EAC1CjC,OAAO,EAAE;kBACU,sBAAqBZ,OAAQ,IAAGsD,+BAAY,EAAG;;CAFnC,CAA5B;;;;"} \ No newline at end of file +{"version":3,"file":"index.js","sources":["../dist-src/version.js","../dist-src/get-buffer-response.js","../dist-src/fetch-wrapper.js","../dist-src/with-defaults.js","../dist-src/index.js"],"sourcesContent":["export const VERSION = \"5.4.2\";\n","export default function getBufferResponse(response) {\n return response.arrayBuffer();\n}\n","import isPlainObject from \"is-plain-object\";\nimport nodeFetch from \"node-fetch\";\nimport { RequestError } from \"@octokit/request-error\";\nimport getBuffer from \"./get-buffer-response\";\nexport default function fetchWrapper(requestOptions) {\n if (isPlainObject(requestOptions.body) ||\n Array.isArray(requestOptions.body)) {\n requestOptions.body = JSON.stringify(requestOptions.body);\n }\n let headers = {};\n let status;\n let url;\n const fetch = (requestOptions.request && requestOptions.request.fetch) || nodeFetch;\n return fetch(requestOptions.url, Object.assign({\n method: requestOptions.method,\n body: requestOptions.body,\n headers: requestOptions.headers,\n redirect: requestOptions.redirect,\n }, requestOptions.request))\n .then((response) => {\n url = response.url;\n status = response.status;\n for (const keyAndValue of response.headers) {\n headers[keyAndValue[0]] = keyAndValue[1];\n }\n if (status === 204 || status === 205) {\n return;\n }\n // GitHub API returns 200 for HEAD requests\n if (requestOptions.method === \"HEAD\") {\n if (status < 400) {\n return;\n }\n throw new RequestError(response.statusText, status, {\n headers,\n request: requestOptions,\n });\n }\n if (status === 304) {\n throw new RequestError(\"Not modified\", status, {\n headers,\n request: requestOptions,\n });\n }\n if (status >= 400) {\n return response\n .text()\n .then((message) => {\n const error = new RequestError(message, status, {\n headers,\n request: requestOptions,\n });\n try {\n let responseBody = JSON.parse(error.message);\n Object.assign(error, responseBody);\n let errors = responseBody.errors;\n // Assumption `errors` would always be in Array format\n error.message =\n error.message + \": \" + errors.map(JSON.stringify).join(\", \");\n }\n catch (e) {\n // ignore, see octokit/rest.js#684\n }\n throw error;\n });\n }\n const contentType = response.headers.get(\"content-type\");\n if (/application\\/json/.test(contentType)) {\n return response.json();\n }\n if (!contentType || /^text\\/|charset=utf-8$/.test(contentType)) {\n return response.text();\n }\n return getBuffer(response);\n })\n .then((data) => {\n return {\n status,\n url,\n headers,\n data,\n };\n })\n .catch((error) => {\n if (error instanceof RequestError) {\n throw error;\n }\n throw new RequestError(error.message, 500, {\n headers,\n request: requestOptions,\n });\n });\n}\n","import fetchWrapper from \"./fetch-wrapper\";\nexport default function withDefaults(oldEndpoint, newDefaults) {\n const endpoint = oldEndpoint.defaults(newDefaults);\n const newApi = function (route, parameters) {\n const endpointOptions = endpoint.merge(route, parameters);\n if (!endpointOptions.request || !endpointOptions.request.hook) {\n return fetchWrapper(endpoint.parse(endpointOptions));\n }\n const request = (route, parameters) => {\n return fetchWrapper(endpoint.parse(endpoint.merge(route, parameters)));\n };\n Object.assign(request, {\n endpoint,\n defaults: withDefaults.bind(null, endpoint),\n });\n return endpointOptions.request.hook(request, endpointOptions);\n };\n return Object.assign(newApi, {\n endpoint,\n defaults: withDefaults.bind(null, endpoint),\n });\n}\n","import { endpoint } from \"@octokit/endpoint\";\nimport { getUserAgent } from \"universal-user-agent\";\nimport { VERSION } from \"./version\";\nimport withDefaults from \"./with-defaults\";\nexport const request = withDefaults(endpoint, {\n headers: {\n \"user-agent\": `octokit-request.js/${VERSION} ${getUserAgent()}`,\n },\n});\n"],"names":["VERSION","getBufferResponse","response","arrayBuffer","fetchWrapper","requestOptions","isPlainObject","body","Array","isArray","JSON","stringify","headers","status","url","fetch","request","nodeFetch","Object","assign","method","redirect","then","keyAndValue","RequestError","statusText","text","message","error","responseBody","parse","errors","map","join","e","contentType","get","test","json","getBuffer","data","catch","withDefaults","oldEndpoint","newDefaults","endpoint","defaults","newApi","route","parameters","endpointOptions","merge","hook","bind","getUserAgent"],"mappings":";;;;;;;;;;;;AAAO,MAAMA,OAAO,GAAG,mBAAhB;;ACAQ,SAASC,iBAAT,CAA2BC,QAA3B,EAAqC;AAChD,SAAOA,QAAQ,CAACC,WAAT,EAAP;AACH;;ACEc,SAASC,YAAT,CAAsBC,cAAtB,EAAsC;AACjD,MAAIC,aAAa,CAACD,cAAc,CAACE,IAAhB,CAAb,IACAC,KAAK,CAACC,OAAN,CAAcJ,cAAc,CAACE,IAA7B,CADJ,EACwC;AACpCF,IAAAA,cAAc,CAACE,IAAf,GAAsBG,IAAI,CAACC,SAAL,CAAeN,cAAc,CAACE,IAA9B,CAAtB;AACH;;AACD,MAAIK,OAAO,GAAG,EAAd;AACA,MAAIC,MAAJ;AACA,MAAIC,GAAJ;AACA,QAAMC,KAAK,GAAIV,cAAc,CAACW,OAAf,IAA0BX,cAAc,CAACW,OAAf,CAAuBD,KAAlD,IAA4DE,SAA1E;AACA,SAAOF,KAAK,CAACV,cAAc,CAACS,GAAhB,EAAqBI,MAAM,CAACC,MAAP,CAAc;AAC3CC,IAAAA,MAAM,EAAEf,cAAc,CAACe,MADoB;AAE3Cb,IAAAA,IAAI,EAAEF,cAAc,CAACE,IAFsB;AAG3CK,IAAAA,OAAO,EAAEP,cAAc,CAACO,OAHmB;AAI3CS,IAAAA,QAAQ,EAAEhB,cAAc,CAACgB;AAJkB,GAAd,EAK9BhB,cAAc,CAACW,OALe,CAArB,CAAL,CAMFM,IANE,CAMIpB,QAAD,IAAc;AACpBY,IAAAA,GAAG,GAAGZ,QAAQ,CAACY,GAAf;AACAD,IAAAA,MAAM,GAAGX,QAAQ,CAACW,MAAlB;;AACA,SAAK,MAAMU,WAAX,IAA0BrB,QAAQ,CAACU,OAAnC,EAA4C;AACxCA,MAAAA,OAAO,CAACW,WAAW,CAAC,CAAD,CAAZ,CAAP,GAA0BA,WAAW,CAAC,CAAD,CAArC;AACH;;AACD,QAAIV,MAAM,KAAK,GAAX,IAAkBA,MAAM,KAAK,GAAjC,EAAsC;AAClC;AACH,KARmB;;;AAUpB,QAAIR,cAAc,CAACe,MAAf,KAA0B,MAA9B,EAAsC;AAClC,UAAIP,MAAM,GAAG,GAAb,EAAkB;AACd;AACH;;AACD,YAAM,IAAIW,yBAAJ,CAAiBtB,QAAQ,CAACuB,UAA1B,EAAsCZ,MAAtC,EAA8C;AAChDD,QAAAA,OADgD;AAEhDI,QAAAA,OAAO,EAAEX;AAFuC,OAA9C,CAAN;AAIH;;AACD,QAAIQ,MAAM,KAAK,GAAf,EAAoB;AAChB,YAAM,IAAIW,yBAAJ,CAAiB,cAAjB,EAAiCX,MAAjC,EAAyC;AAC3CD,QAAAA,OAD2C;AAE3CI,QAAAA,OAAO,EAAEX;AAFkC,OAAzC,CAAN;AAIH;;AACD,QAAIQ,MAAM,IAAI,GAAd,EAAmB;AACf,aAAOX,QAAQ,CACVwB,IADE,GAEFJ,IAFE,CAEIK,OAAD,IAAa;AACnB,cAAMC,KAAK,GAAG,IAAIJ,yBAAJ,CAAiBG,OAAjB,EAA0Bd,MAA1B,EAAkC;AAC5CD,UAAAA,OAD4C;AAE5CI,UAAAA,OAAO,EAAEX;AAFmC,SAAlC,CAAd;;AAIA,YAAI;AACA,cAAIwB,YAAY,GAAGnB,IAAI,CAACoB,KAAL,CAAWF,KAAK,CAACD,OAAjB,CAAnB;AACAT,UAAAA,MAAM,CAACC,MAAP,CAAcS,KAAd,EAAqBC,YAArB;AACA,cAAIE,MAAM,GAAGF,YAAY,CAACE,MAA1B,CAHA;;AAKAH,UAAAA,KAAK,CAACD,OAAN,GACIC,KAAK,CAACD,OAAN,GAAgB,IAAhB,GAAuBI,MAAM,CAACC,GAAP,CAAWtB,IAAI,CAACC,SAAhB,EAA2BsB,IAA3B,CAAgC,IAAhC,CAD3B;AAEH,SAPD,CAQA,OAAOC,CAAP,EAAU;AAET;;AACD,cAAMN,KAAN;AACH,OAnBM,CAAP;AAoBH;;AACD,UAAMO,WAAW,GAAGjC,QAAQ,CAACU,OAAT,CAAiBwB,GAAjB,CAAqB,cAArB,CAApB;;AACA,QAAI,oBAAoBC,IAApB,CAAyBF,WAAzB,CAAJ,EAA2C;AACvC,aAAOjC,QAAQ,CAACoC,IAAT,EAAP;AACH;;AACD,QAAI,CAACH,WAAD,IAAgB,yBAAyBE,IAAzB,CAA8BF,WAA9B,CAApB,EAAgE;AAC5D,aAAOjC,QAAQ,CAACwB,IAAT,EAAP;AACH;;AACD,WAAOa,iBAAS,CAACrC,QAAD,CAAhB;AACH,GA7DM,EA8DFoB,IA9DE,CA8DIkB,IAAD,IAAU;AAChB,WAAO;AACH3B,MAAAA,MADG;AAEHC,MAAAA,GAFG;AAGHF,MAAAA,OAHG;AAIH4B,MAAAA;AAJG,KAAP;AAMH,GArEM,EAsEFC,KAtEE,CAsEKb,KAAD,IAAW;AAClB,QAAIA,KAAK,YAAYJ,yBAArB,EAAmC;AAC/B,YAAMI,KAAN;AACH;;AACD,UAAM,IAAIJ,yBAAJ,CAAiBI,KAAK,CAACD,OAAvB,EAAgC,GAAhC,EAAqC;AACvCf,MAAAA,OADuC;AAEvCI,MAAAA,OAAO,EAAEX;AAF8B,KAArC,CAAN;AAIH,GA9EM,CAAP;AA+EH;;AC3Fc,SAASqC,YAAT,CAAsBC,WAAtB,EAAmCC,WAAnC,EAAgD;AAC3D,QAAMC,QAAQ,GAAGF,WAAW,CAACG,QAAZ,CAAqBF,WAArB,CAAjB;;AACA,QAAMG,MAAM,GAAG,UAAUC,KAAV,EAAiBC,UAAjB,EAA6B;AACxC,UAAMC,eAAe,GAAGL,QAAQ,CAACM,KAAT,CAAeH,KAAf,EAAsBC,UAAtB,CAAxB;;AACA,QAAI,CAACC,eAAe,CAAClC,OAAjB,IAA4B,CAACkC,eAAe,CAAClC,OAAhB,CAAwBoC,IAAzD,EAA+D;AAC3D,aAAOhD,YAAY,CAACyC,QAAQ,CAACf,KAAT,CAAeoB,eAAf,CAAD,CAAnB;AACH;;AACD,UAAMlC,OAAO,GAAG,CAACgC,KAAD,EAAQC,UAAR,KAAuB;AACnC,aAAO7C,YAAY,CAACyC,QAAQ,CAACf,KAAT,CAAee,QAAQ,CAACM,KAAT,CAAeH,KAAf,EAAsBC,UAAtB,CAAf,CAAD,CAAnB;AACH,KAFD;;AAGA/B,IAAAA,MAAM,CAACC,MAAP,CAAcH,OAAd,EAAuB;AACnB6B,MAAAA,QADmB;AAEnBC,MAAAA,QAAQ,EAAEJ,YAAY,CAACW,IAAb,CAAkB,IAAlB,EAAwBR,QAAxB;AAFS,KAAvB;AAIA,WAAOK,eAAe,CAAClC,OAAhB,CAAwBoC,IAAxB,CAA6BpC,OAA7B,EAAsCkC,eAAtC,CAAP;AACH,GAbD;;AAcA,SAAOhC,MAAM,CAACC,MAAP,CAAc4B,MAAd,EAAsB;AACzBF,IAAAA,QADyB;AAEzBC,IAAAA,QAAQ,EAAEJ,YAAY,CAACW,IAAb,CAAkB,IAAlB,EAAwBR,QAAxB;AAFe,GAAtB,CAAP;AAIH;;MCjBY7B,OAAO,GAAG0B,YAAY,CAACG,iBAAD,EAAW;AAC1CjC,EAAAA,OAAO,EAAE;AACL,kBAAe,sBAAqBZ,OAAQ,IAAGsD,+BAAY,EAAG;AADzD;AADiC,CAAX,CAA5B;;;;"} \ No newline at end of file diff --git a/node_modules/@octokit/request/dist-src/fetch-wrapper.js b/node_modules/@octokit/request/dist-src/fetch-wrapper.js index f2b80d7..5fef6e5 100644 --- a/node_modules/@octokit/request/dist-src/fetch-wrapper.js +++ b/node_modules/@octokit/request/dist-src/fetch-wrapper.js @@ -15,9 +15,9 @@ export default function fetchWrapper(requestOptions) { method: requestOptions.method, body: requestOptions.body, headers: requestOptions.headers, - redirect: requestOptions.redirect + redirect: requestOptions.redirect, }, requestOptions.request)) - .then(response => { + .then((response) => { url = response.url; status = response.status; for (const keyAndValue of response.headers) { @@ -26,35 +26,35 @@ export default function fetchWrapper(requestOptions) { if (status === 204 || status === 205) { return; } - // GitHub API returns 200 for HEAD requsets + // GitHub API returns 200 for HEAD requests if (requestOptions.method === "HEAD") { if (status < 400) { return; } throw new RequestError(response.statusText, status, { headers, - request: requestOptions + request: requestOptions, }); } if (status === 304) { throw new RequestError("Not modified", status, { headers, - request: requestOptions + request: requestOptions, }); } if (status >= 400) { return response .text() - .then(message => { + .then((message) => { const error = new RequestError(message, status, { headers, - request: requestOptions + request: requestOptions, }); try { let responseBody = JSON.parse(error.message); Object.assign(error, responseBody); let errors = responseBody.errors; - // Assumption `errors` would always be in Array Fotmat + // Assumption `errors` would always be in Array format error.message = error.message + ": " + errors.map(JSON.stringify).join(", "); } @@ -73,21 +73,21 @@ export default function fetchWrapper(requestOptions) { } return getBuffer(response); }) - .then(data => { + .then((data) => { return { status, url, headers, - data + data, }; }) - .catch(error => { + .catch((error) => { if (error instanceof RequestError) { throw error; } throw new RequestError(error.message, 500, { headers, - request: requestOptions + request: requestOptions, }); }); } diff --git a/node_modules/@octokit/request/dist-src/index.js b/node_modules/@octokit/request/dist-src/index.js index 6a36142..2460e99 100644 --- a/node_modules/@octokit/request/dist-src/index.js +++ b/node_modules/@octokit/request/dist-src/index.js @@ -4,6 +4,6 @@ import { VERSION } from "./version"; import withDefaults from "./with-defaults"; export const request = withDefaults(endpoint, { headers: { - "user-agent": `octokit-request.js/${VERSION} ${getUserAgent()}` - } + "user-agent": `octokit-request.js/${VERSION} ${getUserAgent()}`, + }, }); diff --git a/node_modules/@octokit/request/dist-src/version.js b/node_modules/@octokit/request/dist-src/version.js index 6250d76..2c6e37f 100644 --- a/node_modules/@octokit/request/dist-src/version.js +++ b/node_modules/@octokit/request/dist-src/version.js @@ -1 +1 @@ -export const VERSION = "5.3.1"; +export const VERSION = "5.4.2"; diff --git a/node_modules/@octokit/request/dist-src/with-defaults.js b/node_modules/@octokit/request/dist-src/with-defaults.js index 8e44f46..e206429 100644 --- a/node_modules/@octokit/request/dist-src/with-defaults.js +++ b/node_modules/@octokit/request/dist-src/with-defaults.js @@ -11,12 +11,12 @@ export default function withDefaults(oldEndpoint, newDefaults) { }; Object.assign(request, { endpoint, - defaults: withDefaults.bind(null, endpoint) + defaults: withDefaults.bind(null, endpoint), }); return endpointOptions.request.hook(request, endpointOptions); }; return Object.assign(newApi, { endpoint, - defaults: withDefaults.bind(null, endpoint) + defaults: withDefaults.bind(null, endpoint), }); } diff --git a/node_modules/@octokit/request/dist-types/index.d.ts b/node_modules/@octokit/request/dist-types/index.d.ts index cb9c9ba..1030809 100644 --- a/node_modules/@octokit/request/dist-types/index.d.ts +++ b/node_modules/@octokit/request/dist-types/index.d.ts @@ -1 +1 @@ -export declare const request: import("@octokit/types").RequestInterface; +export declare const request: import("@octokit/types").RequestInterface; diff --git a/node_modules/@octokit/request/dist-types/version.d.ts b/node_modules/@octokit/request/dist-types/version.d.ts index c32c7ab..6f1ae6d 100644 --- a/node_modules/@octokit/request/dist-types/version.d.ts +++ b/node_modules/@octokit/request/dist-types/version.d.ts @@ -1 +1 @@ -export declare const VERSION = "5.3.1"; +export declare const VERSION = "5.4.2"; diff --git a/node_modules/@octokit/request/dist-web/index.js b/node_modules/@octokit/request/dist-web/index.js index 3f51926..e53ed2b 100644 --- a/node_modules/@octokit/request/dist-web/index.js +++ b/node_modules/@octokit/request/dist-web/index.js @@ -4,7 +4,7 @@ import isPlainObject from 'is-plain-object'; import nodeFetch from 'node-fetch'; import { RequestError } from '@octokit/request-error'; -const VERSION = "5.3.1"; +const VERSION = "5.4.2"; function getBufferResponse(response) { return response.arrayBuffer(); @@ -23,9 +23,9 @@ function fetchWrapper(requestOptions) { method: requestOptions.method, body: requestOptions.body, headers: requestOptions.headers, - redirect: requestOptions.redirect + redirect: requestOptions.redirect, }, requestOptions.request)) - .then(response => { + .then((response) => { url = response.url; status = response.status; for (const keyAndValue of response.headers) { @@ -34,35 +34,35 @@ function fetchWrapper(requestOptions) { if (status === 204 || status === 205) { return; } - // GitHub API returns 200 for HEAD requsets + // GitHub API returns 200 for HEAD requests if (requestOptions.method === "HEAD") { if (status < 400) { return; } throw new RequestError(response.statusText, status, { headers, - request: requestOptions + request: requestOptions, }); } if (status === 304) { throw new RequestError("Not modified", status, { headers, - request: requestOptions + request: requestOptions, }); } if (status >= 400) { return response .text() - .then(message => { + .then((message) => { const error = new RequestError(message, status, { headers, - request: requestOptions + request: requestOptions, }); try { let responseBody = JSON.parse(error.message); Object.assign(error, responseBody); let errors = responseBody.errors; - // Assumption `errors` would always be in Array Fotmat + // Assumption `errors` would always be in Array format error.message = error.message + ": " + errors.map(JSON.stringify).join(", "); } @@ -81,21 +81,21 @@ function fetchWrapper(requestOptions) { } return getBufferResponse(response); }) - .then(data => { + .then((data) => { return { status, url, headers, - data + data, }; }) - .catch(error => { + .catch((error) => { if (error instanceof RequestError) { throw error; } throw new RequestError(error.message, 500, { headers, - request: requestOptions + request: requestOptions, }); }); } @@ -112,20 +112,20 @@ function withDefaults(oldEndpoint, newDefaults) { }; Object.assign(request, { endpoint, - defaults: withDefaults.bind(null, endpoint) + defaults: withDefaults.bind(null, endpoint), }); return endpointOptions.request.hook(request, endpointOptions); }; return Object.assign(newApi, { endpoint, - defaults: withDefaults.bind(null, endpoint) + defaults: withDefaults.bind(null, endpoint), }); } const request = withDefaults(endpoint, { headers: { - "user-agent": `octokit-request.js/${VERSION} ${getUserAgent()}` - } + "user-agent": `octokit-request.js/${VERSION} ${getUserAgent()}`, + }, }); export { request }; diff --git a/node_modules/@octokit/request/dist-web/index.js.map b/node_modules/@octokit/request/dist-web/index.js.map index f4c3084..4a676ea 100644 --- a/node_modules/@octokit/request/dist-web/index.js.map +++ b/node_modules/@octokit/request/dist-web/index.js.map @@ -1 +1 @@ -{"version":3,"file":"index.js","sources":["../dist-src/version.js","../dist-src/get-buffer-response.js","../dist-src/fetch-wrapper.js","../dist-src/with-defaults.js","../dist-src/index.js"],"sourcesContent":["export const VERSION = \"5.3.1\";\n","export default function getBufferResponse(response) {\n return response.arrayBuffer();\n}\n","import isPlainObject from \"is-plain-object\";\nimport nodeFetch from \"node-fetch\";\nimport { RequestError } from \"@octokit/request-error\";\nimport getBuffer from \"./get-buffer-response\";\nexport default function fetchWrapper(requestOptions) {\n if (isPlainObject(requestOptions.body) ||\n Array.isArray(requestOptions.body)) {\n requestOptions.body = JSON.stringify(requestOptions.body);\n }\n let headers = {};\n let status;\n let url;\n const fetch = (requestOptions.request && requestOptions.request.fetch) || nodeFetch;\n return fetch(requestOptions.url, Object.assign({\n method: requestOptions.method,\n body: requestOptions.body,\n headers: requestOptions.headers,\n redirect: requestOptions.redirect\n }, requestOptions.request))\n .then(response => {\n url = response.url;\n status = response.status;\n for (const keyAndValue of response.headers) {\n headers[keyAndValue[0]] = keyAndValue[1];\n }\n if (status === 204 || status === 205) {\n return;\n }\n // GitHub API returns 200 for HEAD requsets\n if (requestOptions.method === \"HEAD\") {\n if (status < 400) {\n return;\n }\n throw new RequestError(response.statusText, status, {\n headers,\n request: requestOptions\n });\n }\n if (status === 304) {\n throw new RequestError(\"Not modified\", status, {\n headers,\n request: requestOptions\n });\n }\n if (status >= 400) {\n return response\n .text()\n .then(message => {\n const error = new RequestError(message, status, {\n headers,\n request: requestOptions\n });\n try {\n let responseBody = JSON.parse(error.message);\n Object.assign(error, responseBody);\n let errors = responseBody.errors;\n // Assumption `errors` would always be in Array Fotmat\n error.message =\n error.message + \": \" + errors.map(JSON.stringify).join(\", \");\n }\n catch (e) {\n // ignore, see octokit/rest.js#684\n }\n throw error;\n });\n }\n const contentType = response.headers.get(\"content-type\");\n if (/application\\/json/.test(contentType)) {\n return response.json();\n }\n if (!contentType || /^text\\/|charset=utf-8$/.test(contentType)) {\n return response.text();\n }\n return getBuffer(response);\n })\n .then(data => {\n return {\n status,\n url,\n headers,\n data\n };\n })\n .catch(error => {\n if (error instanceof RequestError) {\n throw error;\n }\n throw new RequestError(error.message, 500, {\n headers,\n request: requestOptions\n });\n });\n}\n","import fetchWrapper from \"./fetch-wrapper\";\nexport default function withDefaults(oldEndpoint, newDefaults) {\n const endpoint = oldEndpoint.defaults(newDefaults);\n const newApi = function (route, parameters) {\n const endpointOptions = endpoint.merge(route, parameters);\n if (!endpointOptions.request || !endpointOptions.request.hook) {\n return fetchWrapper(endpoint.parse(endpointOptions));\n }\n const request = (route, parameters) => {\n return fetchWrapper(endpoint.parse(endpoint.merge(route, parameters)));\n };\n Object.assign(request, {\n endpoint,\n defaults: withDefaults.bind(null, endpoint)\n });\n return endpointOptions.request.hook(request, endpointOptions);\n };\n return Object.assign(newApi, {\n endpoint,\n defaults: withDefaults.bind(null, endpoint)\n });\n}\n","import { endpoint } from \"@octokit/endpoint\";\nimport { getUserAgent } from \"universal-user-agent\";\nimport { VERSION } from \"./version\";\nimport withDefaults from \"./with-defaults\";\nexport const request = withDefaults(endpoint, {\n headers: {\n \"user-agent\": `octokit-request.js/${VERSION} ${getUserAgent()}`\n }\n});\n"],"names":["getBuffer"],"mappings":";;;;;;AAAO,MAAM,OAAO,GAAG,mBAAmB,CAAC;;ACA5B,SAAS,iBAAiB,CAAC,QAAQ,EAAE;IAChD,OAAO,QAAQ,CAAC,WAAW,EAAE,CAAC;CACjC;;ACEc,SAAS,YAAY,CAAC,cAAc,EAAE;IACjD,IAAI,aAAa,CAAC,cAAc,CAAC,IAAI,CAAC;QAClC,KAAK,CAAC,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE;QACpC,cAAc,CAAC,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;KAC7D;IACD,IAAI,OAAO,GAAG,EAAE,CAAC;IACjB,IAAI,MAAM,CAAC;IACX,IAAI,GAAG,CAAC;IACR,MAAM,KAAK,GAAG,CAAC,cAAc,CAAC,OAAO,IAAI,cAAc,CAAC,OAAO,CAAC,KAAK,KAAK,SAAS,CAAC;IACpF,OAAO,KAAK,CAAC,cAAc,CAAC,GAAG,EAAE,MAAM,CAAC,MAAM,CAAC;QAC3C,MAAM,EAAE,cAAc,CAAC,MAAM;QAC7B,IAAI,EAAE,cAAc,CAAC,IAAI;QACzB,OAAO,EAAE,cAAc,CAAC,OAAO;QAC/B,QAAQ,EAAE,cAAc,CAAC,QAAQ;KACpC,EAAE,cAAc,CAAC,OAAO,CAAC,CAAC;SACtB,IAAI,CAAC,QAAQ,IAAI;QAClB,GAAG,GAAG,QAAQ,CAAC,GAAG,CAAC;QACnB,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC;QACzB,KAAK,MAAM,WAAW,IAAI,QAAQ,CAAC,OAAO,EAAE;YACxC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;SAC5C;QACD,IAAI,MAAM,KAAK,GAAG,IAAI,MAAM,KAAK,GAAG,EAAE;YAClC,OAAO;SACV;;QAED,IAAI,cAAc,CAAC,MAAM,KAAK,MAAM,EAAE;YAClC,IAAI,MAAM,GAAG,GAAG,EAAE;gBACd,OAAO;aACV;YACD,MAAM,IAAI,YAAY,CAAC,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE;gBAChD,OAAO;gBACP,OAAO,EAAE,cAAc;aAC1B,CAAC,CAAC;SACN;QACD,IAAI,MAAM,KAAK,GAAG,EAAE;YAChB,MAAM,IAAI,YAAY,CAAC,cAAc,EAAE,MAAM,EAAE;gBAC3C,OAAO;gBACP,OAAO,EAAE,cAAc;aAC1B,CAAC,CAAC;SACN;QACD,IAAI,MAAM,IAAI,GAAG,EAAE;YACf,OAAO,QAAQ;iBACV,IAAI,EAAE;iBACN,IAAI,CAAC,OAAO,IAAI;gBACjB,MAAM,KAAK,GAAG,IAAI,YAAY,CAAC,OAAO,EAAE,MAAM,EAAE;oBAC5C,OAAO;oBACP,OAAO,EAAE,cAAc;iBAC1B,CAAC,CAAC;gBACH,IAAI;oBACA,IAAI,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;oBAC7C,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC;oBACnC,IAAI,MAAM,GAAG,YAAY,CAAC,MAAM,CAAC;;oBAEjC,KAAK,CAAC,OAAO;wBACT,KAAK,CAAC,OAAO,GAAG,IAAI,GAAG,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;iBACpE;gBACD,OAAO,CAAC,EAAE;;iBAET;gBACD,MAAM,KAAK,CAAC;aACf,CAAC,CAAC;SACN;QACD,MAAM,WAAW,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;QACzD,IAAI,mBAAmB,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE;YACvC,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAC;SAC1B;QACD,IAAI,CAAC,WAAW,IAAI,wBAAwB,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE;YAC5D,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAC;SAC1B;QACD,OAAOA,iBAAS,CAAC,QAAQ,CAAC,CAAC;KAC9B,CAAC;SACG,IAAI,CAAC,IAAI,IAAI;QACd,OAAO;YACH,MAAM;YACN,GAAG;YACH,OAAO;YACP,IAAI;SACP,CAAC;KACL,CAAC;SACG,KAAK,CAAC,KAAK,IAAI;QAChB,IAAI,KAAK,YAAY,YAAY,EAAE;YAC/B,MAAM,KAAK,CAAC;SACf;QACD,MAAM,IAAI,YAAY,CAAC,KAAK,CAAC,OAAO,EAAE,GAAG,EAAE;YACvC,OAAO;YACP,OAAO,EAAE,cAAc;SAC1B,CAAC,CAAC;KACN,CAAC,CAAC;CACN;;AC3Fc,SAAS,YAAY,CAAC,WAAW,EAAE,WAAW,EAAE;IAC3D,MAAM,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;IACnD,MAAM,MAAM,GAAG,UAAU,KAAK,EAAE,UAAU,EAAE;QACxC,MAAM,eAAe,GAAG,QAAQ,CAAC,KAAK,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;QAC1D,IAAI,CAAC,eAAe,CAAC,OAAO,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,IAAI,EAAE;YAC3D,OAAO,YAAY,CAAC,QAAQ,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,CAAC;SACxD;QACD,MAAM,OAAO,GAAG,CAAC,KAAK,EAAE,UAAU,KAAK;YACnC,OAAO,YAAY,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC;SAC1E,CAAC;QACF,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE;YACnB,QAAQ;YACR,QAAQ,EAAE,YAAY,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC;SAC9C,CAAC,CAAC;QACH,OAAO,eAAe,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;KACjE,CAAC;IACF,OAAO,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE;QACzB,QAAQ;QACR,QAAQ,EAAE,YAAY,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC;KAC9C,CAAC,CAAC;CACN;;ACjBW,MAAC,OAAO,GAAG,YAAY,CAAC,QAAQ,EAAE;IAC1C,OAAO,EAAE;QACL,YAAY,EAAE,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC,EAAE,YAAY,EAAE,CAAC,CAAC;KAClE;CACJ,CAAC;;;;"} \ No newline at end of file +{"version":3,"file":"index.js","sources":["../dist-src/version.js","../dist-src/get-buffer-response.js","../dist-src/fetch-wrapper.js","../dist-src/with-defaults.js","../dist-src/index.js"],"sourcesContent":["export const VERSION = \"5.4.2\";\n","export default function getBufferResponse(response) {\n return response.arrayBuffer();\n}\n","import isPlainObject from \"is-plain-object\";\nimport nodeFetch from \"node-fetch\";\nimport { RequestError } from \"@octokit/request-error\";\nimport getBuffer from \"./get-buffer-response\";\nexport default function fetchWrapper(requestOptions) {\n if (isPlainObject(requestOptions.body) ||\n Array.isArray(requestOptions.body)) {\n requestOptions.body = JSON.stringify(requestOptions.body);\n }\n let headers = {};\n let status;\n let url;\n const fetch = (requestOptions.request && requestOptions.request.fetch) || nodeFetch;\n return fetch(requestOptions.url, Object.assign({\n method: requestOptions.method,\n body: requestOptions.body,\n headers: requestOptions.headers,\n redirect: requestOptions.redirect,\n }, requestOptions.request))\n .then((response) => {\n url = response.url;\n status = response.status;\n for (const keyAndValue of response.headers) {\n headers[keyAndValue[0]] = keyAndValue[1];\n }\n if (status === 204 || status === 205) {\n return;\n }\n // GitHub API returns 200 for HEAD requests\n if (requestOptions.method === \"HEAD\") {\n if (status < 400) {\n return;\n }\n throw new RequestError(response.statusText, status, {\n headers,\n request: requestOptions,\n });\n }\n if (status === 304) {\n throw new RequestError(\"Not modified\", status, {\n headers,\n request: requestOptions,\n });\n }\n if (status >= 400) {\n return response\n .text()\n .then((message) => {\n const error = new RequestError(message, status, {\n headers,\n request: requestOptions,\n });\n try {\n let responseBody = JSON.parse(error.message);\n Object.assign(error, responseBody);\n let errors = responseBody.errors;\n // Assumption `errors` would always be in Array format\n error.message =\n error.message + \": \" + errors.map(JSON.stringify).join(\", \");\n }\n catch (e) {\n // ignore, see octokit/rest.js#684\n }\n throw error;\n });\n }\n const contentType = response.headers.get(\"content-type\");\n if (/application\\/json/.test(contentType)) {\n return response.json();\n }\n if (!contentType || /^text\\/|charset=utf-8$/.test(contentType)) {\n return response.text();\n }\n return getBuffer(response);\n })\n .then((data) => {\n return {\n status,\n url,\n headers,\n data,\n };\n })\n .catch((error) => {\n if (error instanceof RequestError) {\n throw error;\n }\n throw new RequestError(error.message, 500, {\n headers,\n request: requestOptions,\n });\n });\n}\n","import fetchWrapper from \"./fetch-wrapper\";\nexport default function withDefaults(oldEndpoint, newDefaults) {\n const endpoint = oldEndpoint.defaults(newDefaults);\n const newApi = function (route, parameters) {\n const endpointOptions = endpoint.merge(route, parameters);\n if (!endpointOptions.request || !endpointOptions.request.hook) {\n return fetchWrapper(endpoint.parse(endpointOptions));\n }\n const request = (route, parameters) => {\n return fetchWrapper(endpoint.parse(endpoint.merge(route, parameters)));\n };\n Object.assign(request, {\n endpoint,\n defaults: withDefaults.bind(null, endpoint),\n });\n return endpointOptions.request.hook(request, endpointOptions);\n };\n return Object.assign(newApi, {\n endpoint,\n defaults: withDefaults.bind(null, endpoint),\n });\n}\n","import { endpoint } from \"@octokit/endpoint\";\nimport { getUserAgent } from \"universal-user-agent\";\nimport { VERSION } from \"./version\";\nimport withDefaults from \"./with-defaults\";\nexport const request = withDefaults(endpoint, {\n headers: {\n \"user-agent\": `octokit-request.js/${VERSION} ${getUserAgent()}`,\n },\n});\n"],"names":["getBuffer"],"mappings":";;;;;;AAAO,MAAM,OAAO,GAAG,mBAAmB;;ACA3B,SAAS,iBAAiB,CAAC,QAAQ,EAAE;AACpD,IAAI,OAAO,QAAQ,CAAC,WAAW,EAAE,CAAC;AAClC,CAAC;;ACEc,SAAS,YAAY,CAAC,cAAc,EAAE;AACrD,IAAI,IAAI,aAAa,CAAC,cAAc,CAAC,IAAI,CAAC;AAC1C,QAAQ,KAAK,CAAC,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE;AAC5C,QAAQ,cAAc,CAAC,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;AAClE,KAAK;AACL,IAAI,IAAI,OAAO,GAAG,EAAE,CAAC;AACrB,IAAI,IAAI,MAAM,CAAC;AACf,IAAI,IAAI,GAAG,CAAC;AACZ,IAAI,MAAM,KAAK,GAAG,CAAC,cAAc,CAAC,OAAO,IAAI,cAAc,CAAC,OAAO,CAAC,KAAK,KAAK,SAAS,CAAC;AACxF,IAAI,OAAO,KAAK,CAAC,cAAc,CAAC,GAAG,EAAE,MAAM,CAAC,MAAM,CAAC;AACnD,QAAQ,MAAM,EAAE,cAAc,CAAC,MAAM;AACrC,QAAQ,IAAI,EAAE,cAAc,CAAC,IAAI;AACjC,QAAQ,OAAO,EAAE,cAAc,CAAC,OAAO;AACvC,QAAQ,QAAQ,EAAE,cAAc,CAAC,QAAQ;AACzC,KAAK,EAAE,cAAc,CAAC,OAAO,CAAC,CAAC;AAC/B,SAAS,IAAI,CAAC,CAAC,QAAQ,KAAK;AAC5B,QAAQ,GAAG,GAAG,QAAQ,CAAC,GAAG,CAAC;AAC3B,QAAQ,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC;AACjC,QAAQ,KAAK,MAAM,WAAW,IAAI,QAAQ,CAAC,OAAO,EAAE;AACpD,YAAY,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;AACrD,SAAS;AACT,QAAQ,IAAI,MAAM,KAAK,GAAG,IAAI,MAAM,KAAK,GAAG,EAAE;AAC9C,YAAY,OAAO;AACnB,SAAS;AACT;AACA,QAAQ,IAAI,cAAc,CAAC,MAAM,KAAK,MAAM,EAAE;AAC9C,YAAY,IAAI,MAAM,GAAG,GAAG,EAAE;AAC9B,gBAAgB,OAAO;AACvB,aAAa;AACb,YAAY,MAAM,IAAI,YAAY,CAAC,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE;AAChE,gBAAgB,OAAO;AACvB,gBAAgB,OAAO,EAAE,cAAc;AACvC,aAAa,CAAC,CAAC;AACf,SAAS;AACT,QAAQ,IAAI,MAAM,KAAK,GAAG,EAAE;AAC5B,YAAY,MAAM,IAAI,YAAY,CAAC,cAAc,EAAE,MAAM,EAAE;AAC3D,gBAAgB,OAAO;AACvB,gBAAgB,OAAO,EAAE,cAAc;AACvC,aAAa,CAAC,CAAC;AACf,SAAS;AACT,QAAQ,IAAI,MAAM,IAAI,GAAG,EAAE;AAC3B,YAAY,OAAO,QAAQ;AAC3B,iBAAiB,IAAI,EAAE;AACvB,iBAAiB,IAAI,CAAC,CAAC,OAAO,KAAK;AACnC,gBAAgB,MAAM,KAAK,GAAG,IAAI,YAAY,CAAC,OAAO,EAAE,MAAM,EAAE;AAChE,oBAAoB,OAAO;AAC3B,oBAAoB,OAAO,EAAE,cAAc;AAC3C,iBAAiB,CAAC,CAAC;AACnB,gBAAgB,IAAI;AACpB,oBAAoB,IAAI,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;AACjE,oBAAoB,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC;AACvD,oBAAoB,IAAI,MAAM,GAAG,YAAY,CAAC,MAAM,CAAC;AACrD;AACA,oBAAoB,KAAK,CAAC,OAAO;AACjC,wBAAwB,KAAK,CAAC,OAAO,GAAG,IAAI,GAAG,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACrF,iBAAiB;AACjB,gBAAgB,OAAO,CAAC,EAAE;AAC1B;AACA,iBAAiB;AACjB,gBAAgB,MAAM,KAAK,CAAC;AAC5B,aAAa,CAAC,CAAC;AACf,SAAS;AACT,QAAQ,MAAM,WAAW,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;AACjE,QAAQ,IAAI,mBAAmB,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE;AACnD,YAAY,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAC;AACnC,SAAS;AACT,QAAQ,IAAI,CAAC,WAAW,IAAI,wBAAwB,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE;AACxE,YAAY,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAC;AACnC,SAAS;AACT,QAAQ,OAAOA,iBAAS,CAAC,QAAQ,CAAC,CAAC;AACnC,KAAK,CAAC;AACN,SAAS,IAAI,CAAC,CAAC,IAAI,KAAK;AACxB,QAAQ,OAAO;AACf,YAAY,MAAM;AAClB,YAAY,GAAG;AACf,YAAY,OAAO;AACnB,YAAY,IAAI;AAChB,SAAS,CAAC;AACV,KAAK,CAAC;AACN,SAAS,KAAK,CAAC,CAAC,KAAK,KAAK;AAC1B,QAAQ,IAAI,KAAK,YAAY,YAAY,EAAE;AAC3C,YAAY,MAAM,KAAK,CAAC;AACxB,SAAS;AACT,QAAQ,MAAM,IAAI,YAAY,CAAC,KAAK,CAAC,OAAO,EAAE,GAAG,EAAE;AACnD,YAAY,OAAO;AACnB,YAAY,OAAO,EAAE,cAAc;AACnC,SAAS,CAAC,CAAC;AACX,KAAK,CAAC,CAAC;AACP,CAAC;;AC3Fc,SAAS,YAAY,CAAC,WAAW,EAAE,WAAW,EAAE;AAC/D,IAAI,MAAM,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;AACvD,IAAI,MAAM,MAAM,GAAG,UAAU,KAAK,EAAE,UAAU,EAAE;AAChD,QAAQ,MAAM,eAAe,GAAG,QAAQ,CAAC,KAAK,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;AAClE,QAAQ,IAAI,CAAC,eAAe,CAAC,OAAO,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,IAAI,EAAE;AACvE,YAAY,OAAO,YAAY,CAAC,QAAQ,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,CAAC;AACjE,SAAS;AACT,QAAQ,MAAM,OAAO,GAAG,CAAC,KAAK,EAAE,UAAU,KAAK;AAC/C,YAAY,OAAO,YAAY,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC;AACnF,SAAS,CAAC;AACV,QAAQ,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE;AAC/B,YAAY,QAAQ;AACpB,YAAY,QAAQ,EAAE,YAAY,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC;AACvD,SAAS,CAAC,CAAC;AACX,QAAQ,OAAO,eAAe,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;AACtE,KAAK,CAAC;AACN,IAAI,OAAO,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE;AACjC,QAAQ,QAAQ;AAChB,QAAQ,QAAQ,EAAE,YAAY,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC;AACnD,KAAK,CAAC,CAAC;AACP,CAAC;;ACjBW,MAAC,OAAO,GAAG,YAAY,CAAC,QAAQ,EAAE;AAC9C,IAAI,OAAO,EAAE;AACb,QAAQ,YAAY,EAAE,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC,EAAE,YAAY,EAAE,CAAC,CAAC;AACvE,KAAK;AACL,CAAC,CAAC;;;;"} \ No newline at end of file diff --git a/node_modules/@octokit/request/node_modules/universal-user-agent/dist-node/index.js b/node_modules/@octokit/request/node_modules/universal-user-agent/dist-node/index.js index 80a0710..c2534ce 100644 --- a/node_modules/@octokit/request/node_modules/universal-user-agent/dist-node/index.js +++ b/node_modules/@octokit/request/node_modules/universal-user-agent/dist-node/index.js @@ -14,7 +14,7 @@ function getUserAgent() { return "Windows "; } - throw error; + return ""; } } diff --git a/node_modules/@octokit/request/node_modules/universal-user-agent/dist-node/index.js.map b/node_modules/@octokit/request/node_modules/universal-user-agent/dist-node/index.js.map index aff09ec..6f15e8d 100644 --- a/node_modules/@octokit/request/node_modules/universal-user-agent/dist-node/index.js.map +++ b/node_modules/@octokit/request/node_modules/universal-user-agent/dist-node/index.js.map @@ -1 +1 @@ -{"version":3,"file":"index.js","sources":["../dist-src/node.js"],"sourcesContent":["import osName from \"os-name\";\nexport function getUserAgent() {\n try {\n return `Node.js/${process.version.substr(1)} (${osName()}; ${process.arch})`;\n }\n catch (error) {\n if (/wmic os get Caption/.test(error.message)) {\n return \"Windows \";\n }\n throw error;\n }\n}\n"],"names":["getUserAgent","process","version","substr","osName","arch","error","test","message"],"mappings":";;;;;;;;AACO,SAASA,YAAT,GAAwB;MACvB;WACQ,WAAUC,OAAO,CAACC,OAAR,CAAgBC,MAAhB,CAAuB,CAAvB,CAA0B,KAAIC,MAAM,EAAG,KAAIH,OAAO,CAACI,IAAK,GAA1E;GADJ,CAGA,OAAOC,KAAP,EAAc;QACN,sBAAsBC,IAAtB,CAA2BD,KAAK,CAACE,OAAjC,CAAJ,EAA+C;aACpC,gCAAP;;;UAEEF,KAAN;;;;;;"} \ No newline at end of file +{"version":3,"file":"index.js","sources":["../dist-src/node.js"],"sourcesContent":["import osName from \"os-name\";\nexport function getUserAgent() {\n try {\n return `Node.js/${process.version.substr(1)} (${osName()}; ${process.arch})`;\n }\n catch (error) {\n if (/wmic os get Caption/.test(error.message)) {\n return \"Windows \";\n }\n return \"\";\n }\n}\n"],"names":["getUserAgent","process","version","substr","osName","arch","error","test","message"],"mappings":";;;;;;;;AACO,SAASA,YAAT,GAAwB;MACvB;WACQ,WAAUC,OAAO,CAACC,OAAR,CAAgBC,MAAhB,CAAuB,CAAvB,CAA0B,KAAIC,MAAM,EAAG,KAAIH,OAAO,CAACI,IAAK,GAA1E;GADJ,CAGA,OAAOC,KAAP,EAAc;QACN,sBAAsBC,IAAtB,CAA2BD,KAAK,CAACE,OAAjC,CAAJ,EAA+C;aACpC,gCAAP;;;WAEG,4BAAP;;;;;;"} \ No newline at end of file diff --git a/node_modules/@octokit/request/node_modules/universal-user-agent/dist-src/browser.js b/node_modules/@octokit/request/node_modules/universal-user-agent/dist-src/browser.js index 6f52232..8903ac9 100644 --- a/node_modules/@octokit/request/node_modules/universal-user-agent/dist-src/browser.js +++ b/node_modules/@octokit/request/node_modules/universal-user-agent/dist-src/browser.js @@ -1,3 +1,8 @@ export function getUserAgent() { - return navigator.userAgent; + try { + return navigator.userAgent; + } + catch (e) { + return ""; + } } diff --git a/node_modules/@octokit/request/node_modules/universal-user-agent/dist-src/node.js b/node_modules/@octokit/request/node_modules/universal-user-agent/dist-src/node.js index 8b70a03..ba148f0 100644 --- a/node_modules/@octokit/request/node_modules/universal-user-agent/dist-src/node.js +++ b/node_modules/@octokit/request/node_modules/universal-user-agent/dist-src/node.js @@ -7,6 +7,6 @@ export function getUserAgent() { if (/wmic os get Caption/.test(error.message)) { return "Windows "; } - throw error; + return ""; } } diff --git a/node_modules/@octokit/request/node_modules/universal-user-agent/dist-web/index.js b/node_modules/@octokit/request/node_modules/universal-user-agent/dist-web/index.js index 11ec79b..c76d6e5 100644 --- a/node_modules/@octokit/request/node_modules/universal-user-agent/dist-web/index.js +++ b/node_modules/@octokit/request/node_modules/universal-user-agent/dist-web/index.js @@ -1,5 +1,10 @@ function getUserAgent() { - return navigator.userAgent; + try { + return navigator.userAgent; + } + catch (e) { + return ""; + } } export { getUserAgent }; diff --git a/node_modules/@octokit/request/node_modules/universal-user-agent/dist-web/index.js.map b/node_modules/@octokit/request/node_modules/universal-user-agent/dist-web/index.js.map index 549407e..f4b20c3 100644 --- a/node_modules/@octokit/request/node_modules/universal-user-agent/dist-web/index.js.map +++ b/node_modules/@octokit/request/node_modules/universal-user-agent/dist-web/index.js.map @@ -1 +1 @@ -{"version":3,"file":"index.js","sources":["../dist-src/browser.js"],"sourcesContent":["export function getUserAgent() {\n return navigator.userAgent;\n}\n"],"names":[],"mappings":"AAAO,SAAS,YAAY,GAAG;IAC3B,OAAO,SAAS,CAAC,SAAS,CAAC;CAC9B;;;;"} \ No newline at end of file +{"version":3,"file":"index.js","sources":["../dist-src/browser.js"],"sourcesContent":["export function getUserAgent() {\n try {\n return navigator.userAgent;\n }\n catch (e) {\n return \"\";\n }\n}\n"],"names":[],"mappings":"AAAO,SAAS,YAAY,GAAG;IAC3B,IAAI;QACA,OAAO,SAAS,CAAC,SAAS,CAAC;KAC9B;IACD,OAAO,CAAC,EAAE;QACN,OAAO,4BAA4B,CAAC;KACvC;CACJ;;;;"} \ No newline at end of file diff --git a/node_modules/@octokit/request/node_modules/universal-user-agent/package.json b/node_modules/@octokit/request/node_modules/universal-user-agent/package.json index d366be6..e81a8f5 100644 --- a/node_modules/@octokit/request/node_modules/universal-user-agent/package.json +++ b/node_modules/@octokit/request/node_modules/universal-user-agent/package.json @@ -1,46 +1,49 @@ { - "_from": "universal-user-agent@^4.0.0", - "_id": "universal-user-agent@4.0.0", + "_args": [ + [ + "universal-user-agent@5.0.0", + "/Users/marocchino/Documents/sticky-pull-request-comment" + ] + ], + "_from": "universal-user-agent@5.0.0", + "_id": "universal-user-agent@5.0.0", "_inBundle": false, - "_integrity": "sha512-eM8knLpev67iBDizr/YtqkJsF3GK8gzDc6st/WKzrTuPtcsOKW/0IdL4cnMBsU69pOx0otavLWBDGTwg+dB0aA==", + "_integrity": "sha512-B5TPtzZleXyPrUMKCpEHFmVhMN6EhmJYjG5PQna9s7mXeSqGTLap4OpqLl5FCEFUI3UBmllkETwKf/db66Y54Q==", "_location": "/@octokit/request/universal-user-agent", "_phantomChildren": {}, "_requested": { - "type": "range", + "type": "version", "registry": true, - "raw": "universal-user-agent@^4.0.0", + "raw": "universal-user-agent@5.0.0", "name": "universal-user-agent", "escapedName": "universal-user-agent", - "rawSpec": "^4.0.0", + "rawSpec": "5.0.0", "saveSpec": null, - "fetchSpec": "^4.0.0" + "fetchSpec": "5.0.0" }, "_requiredBy": [ "/@octokit/request" ], - "_resolved": "https://registry.npmjs.org/universal-user-agent/-/universal-user-agent-4.0.0.tgz", - "_shasum": "27da2ec87e32769619f68a14996465ea1cb9df16", - "_spec": "universal-user-agent@^4.0.0", - "_where": "/Users/shim.taewon/Documents/sticky-pull-request-comment/node_modules/@octokit/request", + "_resolved": "https://registry.npmjs.org/universal-user-agent/-/universal-user-agent-5.0.0.tgz", + "_spec": "5.0.0", + "_where": "/Users/marocchino/Documents/sticky-pull-request-comment", "bugs": { "url": "https://github.com/gr2m/universal-user-agent/issues" }, - "bundleDependencies": false, "dependencies": { "os-name": "^3.1.0" }, - "deprecated": false, "description": "Get a user agent string in both browser and node", "devDependencies": { "@gr2m/pika-plugin-build-web": "^0.6.0-issue-84.1", "@pika/pack": "^0.5.0", - "@pika/plugin-build-node": "^0.6.0", - "@pika/plugin-ts-standard-pkg": "^0.6.0", - "@types/jest": "^24.0.18", + "@pika/plugin-build-node": "^0.9.1", + "@pika/plugin-ts-standard-pkg": "^0.9.1", + "@types/jest": "^25.1.0", "jest": "^24.9.0", "prettier": "^1.18.2", - "semantic-release": "^15.9.15", - "ts-jest": "^24.0.2", + "semantic-release": "^17.0.0", + "ts-jest": "^25.1.0", "typescript": "^3.6.2" }, "files": [ @@ -61,5 +64,5 @@ "sideEffects": false, "source": "dist-src/index.js", "types": "dist-types/index.d.ts", - "version": "4.0.0" + "version": "5.0.0" } diff --git a/node_modules/@octokit/request/package.json b/node_modules/@octokit/request/package.json index 192ced4..cc2c00c 100644 --- a/node_modules/@octokit/request/package.json +++ b/node_modules/@octokit/request/package.json @@ -1,67 +1,69 @@ { - "_from": "@octokit/request@^5.0.0", - "_id": "@octokit/request@5.3.1", + "_args": [ + [ + "@octokit/request@5.4.2", + "/Users/marocchino/Documents/sticky-pull-request-comment" + ] + ], + "_from": "@octokit/request@5.4.2", + "_id": "@octokit/request@5.4.2", "_inBundle": false, - "_integrity": "sha512-5/X0AL1ZgoU32fAepTfEoggFinO3rxsMLtzhlUX+RctLrusn/CApJuGFCd0v7GMFhF+8UiCsTTfsu7Fh1HnEJg==", + "_integrity": "sha512-zKdnGuQ2TQ2vFk9VU8awFT4+EYf92Z/v3OlzRaSh4RIP0H6cvW1BFPXq4XYvNez+TPQjqN+0uSkCYnMFFhcFrw==", "_location": "/@octokit/request", "_phantomChildren": { "os-name": "3.1.0" }, "_requested": { - "type": "range", + "type": "version", "registry": true, - "raw": "@octokit/request@^5.0.0", + "raw": "@octokit/request@5.4.2", "name": "@octokit/request", "escapedName": "@octokit%2frequest", "scope": "@octokit", - "rawSpec": "^5.0.0", + "rawSpec": "5.4.2", "saveSpec": null, - "fetchSpec": "^5.0.0" + "fetchSpec": "5.4.2" }, "_requiredBy": [ "/@octokit/graphql", "/@octokit/rest" ], - "_resolved": "https://registry.npmjs.org/@octokit/request/-/request-5.3.1.tgz", - "_shasum": "3a1ace45e6f88b1be4749c5da963b3a3b4a2f120", - "_spec": "@octokit/request@^5.0.0", - "_where": "/Users/shim.taewon/Documents/sticky-pull-request-comment/node_modules/@octokit/graphql", + "_resolved": "https://registry.npmjs.org/@octokit/request/-/request-5.4.2.tgz", + "_spec": "5.4.2", + "_where": "/Users/marocchino/Documents/sticky-pull-request-comment", "bugs": { "url": "https://github.com/octokit/request.js/issues" }, - "bundleDependencies": false, - "deno": "dist-web/index.js", "dependencies": { - "@octokit/endpoint": "^5.5.0", - "@octokit/request-error": "^1.0.1", - "@octokit/types": "^2.0.0", + "@octokit/endpoint": "^6.0.1", + "@octokit/request-error": "^2.0.0", + "@octokit/types": "^2.11.1", "deprecation": "^2.0.0", "is-plain-object": "^3.0.0", "node-fetch": "^2.3.0", "once": "^1.4.0", - "universal-user-agent": "^4.0.0" + "universal-user-agent": "^5.0.0" }, - "deprecated": false, "description": "Send parameterized requests to GitHub’s APIs with sensible defaults in browsers and Node", "devDependencies": { "@octokit/auth-app": "^2.1.2", "@pika/pack": "^0.5.0", - "@pika/plugin-build-node": "^0.7.0", - "@pika/plugin-build-web": "^0.7.0", - "@pika/plugin-ts-standard-pkg": "^0.7.0", + "@pika/plugin-build-node": "^0.9.0", + "@pika/plugin-build-web": "^0.9.0", + "@pika/plugin-ts-standard-pkg": "^0.9.0", "@types/fetch-mock": "^7.2.4", - "@types/jest": "^24.0.12", - "@types/lolex": "^3.1.1", - "@types/node": "^12.0.3", + "@types/jest": "^25.1.0", + "@types/lolex": "^5.1.0", + "@types/node": "^13.1.0", "@types/node-fetch": "^2.3.3", "@types/once": "^1.4.0", - "fetch-mock": "^7.2.0", + "fetch-mock": "^9.3.1", "jest": "^24.7.1", - "lolex": "^5.0.0", - "prettier": "^1.17.0", - "semantic-release": "^15.13.27", + "lolex": "^6.0.0", + "prettier": "^2.0.1", + "semantic-release": "^17.0.0", "semantic-release-plugin-update-version-in-files": "^1.0.0", - "ts-jest": "^24.0.2", + "ts-jest": "^25.1.0", "typescript": "^3.4.5" }, "files": [ @@ -77,6 +79,7 @@ ], "license": "MIT", "main": "dist-node/index.js", + "module": "dist-web/index.js", "name": "@octokit/request", "pika": true, "publishConfig": { @@ -89,5 +92,5 @@ "sideEffects": false, "source": "dist-src/index.js", "types": "dist-types/index.d.ts", - "version": "5.3.1" + "version": "5.4.2" } diff --git a/node_modules/@octokit/rest/README.md b/node_modules/@octokit/rest/README.md index 2a31824..2dd4397 100644 --- a/node_modules/@octokit/rest/README.md +++ b/node_modules/@octokit/rest/README.md @@ -15,7 +15,7 @@ npm install @octokit/rest ## Usage ```js -const Octokit = require("@octokit/rest"); +const { Octokit } = require("@octokit/rest"); const octokit = new Octokit(); // Compare: https://developer.github.com/v3/repos/#list-organization-repositories diff --git a/node_modules/@octokit/rest/index.d.ts b/node_modules/@octokit/rest/index.d.ts index a455028..1da80b3 100644 --- a/node_modules/@octokit/rest/index.d.ts +++ b/node_modules/@octokit/rest/index.d.ts @@ -50,11 +50,13 @@ declare namespace Octokit { export interface EmptyParams {} export interface Options { + authStrategy?: any; auth?: | string | { username: string; password: string; on2fa: () => Promise } | { clientId: string; clientSecret: string } - | { (): string | Promise }; + | { (): string | Promise } + | any; userAgent?: string; previews?: string[]; baseUrl?: string; @@ -68,9 +70,18 @@ declare namespace Octokit { agent?: http.Agent; timeout?: number; }; - timeout?: number; // Deprecated - headers?: { [header: string]: any }; // Deprecated - agent?: http.Agent; // Deprecated + /** + * @deprecated Use {request: {timeout}} instead. See https://github.com/octokit/request.js#request + */ + timeout?: number; + /** + * @deprecated Use {userAgent, previews} instead. See https://github.com/octokit/request.js#request + */ + headers?: { [header: string]: any }; + /** + * @deprecated Use {request: {agent}} instead. See https://github.com/octokit/request.js#request + */ + agent?: http.Agent; [option: string]: any; } @@ -332,15 +343,7 @@ declare namespace Octokit { visibility: string; }; type UsersListPublicKeysForUserResponseItem = { id: number; key: string }; - type UsersListPublicKeysResponseItem = { - created_at: string; - id: number; - key: string; - read_only: boolean; - title: string; - url: string; - verified: boolean; - }; + type UsersListPublicKeysResponseItem = { key: string; key_id: string }; type UsersListPublicEmailsResponseItem = { email: string; primary: boolean; @@ -537,15 +540,7 @@ declare namespace Octokit { type: string; url: string; }; - type UsersGetPublicKeyResponse = { - created_at: string; - id: number; - key: string; - read_only: boolean; - title: string; - url: string; - verified: boolean; - }; + type UsersGetPublicKeyResponse = { key: string; key_id: string }; type UsersGetGpgKeyResponseSubkeysItem = { can_certify: boolean; can_encrypt_comms: boolean; @@ -668,15 +663,7 @@ declare namespace Octokit { updated_at: string; url: string; }; - type UsersCreatePublicKeyResponse = { - created_at: string; - id: number; - key: string; - read_only: boolean; - title: string; - url: string; - verified: boolean; - }; + type UsersCreatePublicKeyResponse = { key: string; key_id: string }; type UsersCreateGpgKeyResponseSubkeysItem = { can_certify: boolean; can_encrypt_comms: boolean; @@ -715,6 +702,292 @@ declare namespace Octokit { verified: boolean; visibility: string | null; }; + type TeamsUpdateLegacyResponseOrganization = { + avatar_url: string; + blog: string; + company: string; + created_at: string; + description: string; + email: string; + events_url: string; + followers: number; + following: number; + has_organization_projects: boolean; + has_repository_projects: boolean; + hooks_url: string; + html_url: string; + id: number; + is_verified: boolean; + issues_url: string; + location: string; + login: string; + members_url: string; + name: string; + node_id: string; + public_gists: number; + public_members_url: string; + public_repos: number; + repos_url: string; + type: string; + url: string; + }; + type TeamsUpdateLegacyResponse = { + created_at: string; + description: string; + html_url: string; + id: number; + members_count: number; + members_url: string; + name: string; + node_id: string; + organization: TeamsUpdateLegacyResponseOrganization; + parent: null; + permission: string; + privacy: string; + repos_count: number; + repositories_url: string; + slug: string; + updated_at: string; + url: string; + }; + type TeamsUpdateInOrgResponseOrganization = { + avatar_url: string; + blog: string; + company: string; + created_at: string; + description: string; + email: string; + events_url: string; + followers: number; + following: number; + has_organization_projects: boolean; + has_repository_projects: boolean; + hooks_url: string; + html_url: string; + id: number; + is_verified: boolean; + issues_url: string; + location: string; + login: string; + members_url: string; + name: string; + node_id: string; + public_gists: number; + public_members_url: string; + public_repos: number; + repos_url: string; + type: string; + url: string; + }; + type TeamsUpdateInOrgResponse = { + created_at: string; + description: string; + html_url: string; + id: number; + members_count: number; + members_url: string; + name: string; + node_id: string; + organization: TeamsUpdateInOrgResponseOrganization; + parent: null; + permission: string; + privacy: string; + repos_count: number; + repositories_url: string; + slug: string; + updated_at: string; + url: string; + }; + type TeamsUpdateDiscussionLegacyResponseReactions = { + "+1": number; + "-1": number; + confused: number; + heart: number; + hooray: number; + laugh: number; + total_count: number; + url: string; + }; + type TeamsUpdateDiscussionLegacyResponseAuthor = { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; + id: number; + login: string; + node_id: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; + url: string; + }; + type TeamsUpdateDiscussionLegacyResponse = { + author: TeamsUpdateDiscussionLegacyResponseAuthor; + body: string; + body_html: string; + body_version: string; + comments_count: number; + comments_url: string; + created_at: string; + html_url: string; + last_edited_at: string; + node_id: string; + number: number; + pinned: boolean; + private: boolean; + reactions: TeamsUpdateDiscussionLegacyResponseReactions; + team_url: string; + title: string; + updated_at: string; + url: string; + }; + type TeamsUpdateDiscussionInOrgResponseReactions = { + "+1": number; + "-1": number; + confused: number; + heart: number; + hooray: number; + laugh: number; + total_count: number; + url: string; + }; + type TeamsUpdateDiscussionInOrgResponseAuthor = { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; + id: number; + login: string; + node_id: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; + url: string; + }; + type TeamsUpdateDiscussionInOrgResponse = { + author: TeamsUpdateDiscussionInOrgResponseAuthor; + body: string; + body_html: string; + body_version: string; + comments_count: number; + comments_url: string; + created_at: string; + html_url: string; + last_edited_at: string; + node_id: string; + number: number; + pinned: boolean; + private: boolean; + reactions: TeamsUpdateDiscussionInOrgResponseReactions; + team_url: string; + title: string; + updated_at: string; + url: string; + }; + type TeamsUpdateDiscussionCommentLegacyResponseReactions = { + "+1": number; + "-1": number; + confused: number; + heart: number; + hooray: number; + laugh: number; + total_count: number; + url: string; + }; + type TeamsUpdateDiscussionCommentLegacyResponseAuthor = { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; + id: number; + login: string; + node_id: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; + url: string; + }; + type TeamsUpdateDiscussionCommentLegacyResponse = { + author: TeamsUpdateDiscussionCommentLegacyResponseAuthor; + body: string; + body_html: string; + body_version: string; + created_at: string; + discussion_url: string; + html_url: string; + last_edited_at: string; + node_id: string; + number: number; + reactions: TeamsUpdateDiscussionCommentLegacyResponseReactions; + updated_at: string; + url: string; + }; + type TeamsUpdateDiscussionCommentInOrgResponseReactions = { + "+1": number; + "-1": number; + confused: number; + heart: number; + hooray: number; + laugh: number; + total_count: number; + url: string; + }; + type TeamsUpdateDiscussionCommentInOrgResponseAuthor = { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; + id: number; + login: string; + node_id: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; + url: string; + }; + type TeamsUpdateDiscussionCommentInOrgResponse = { + author: TeamsUpdateDiscussionCommentInOrgResponseAuthor; + body: string; + body_html: string; + body_version: string; + created_at: string; + discussion_url: string; + html_url: string; + last_edited_at: string; + node_id: string; + number: number; + reactions: TeamsUpdateDiscussionCommentInOrgResponseReactions; + updated_at: string; + url: string; + }; type TeamsUpdateDiscussionCommentResponseReactions = { "+1": number; "-1": number; @@ -858,6 +1131,92 @@ declare namespace Octokit { updated_at: string; url: string; }; + type TeamsReviewProjectLegacyResponsePermissions = { + admin: boolean; + read: boolean; + write: boolean; + }; + type TeamsReviewProjectLegacyResponseCreator = { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; + id: number; + login: string; + node_id: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; + url: string; + }; + type TeamsReviewProjectLegacyResponse = { + body: string; + columns_url: string; + created_at: string; + creator: TeamsReviewProjectLegacyResponseCreator; + html_url: string; + id: number; + name: string; + node_id: string; + number: number; + organization_permission: string; + owner_url: string; + permissions: TeamsReviewProjectLegacyResponsePermissions; + private: boolean; + state: string; + updated_at: string; + url: string; + }; + type TeamsReviewProjectInOrgResponsePermissions = { + admin: boolean; + read: boolean; + write: boolean; + }; + type TeamsReviewProjectInOrgResponseCreator = { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; + id: number; + login: string; + node_id: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; + url: string; + }; + type TeamsReviewProjectInOrgResponse = { + body: string; + columns_url: string; + created_at: string; + creator: TeamsReviewProjectInOrgResponseCreator; + html_url: string; + id: number; + name: string; + node_id: string; + number: number; + organization_permission: string; + owner_url: string; + permissions: TeamsReviewProjectInOrgResponsePermissions; + private: boolean; + state: string; + updated_at: string; + url: string; + }; type TeamsReviewProjectResponsePermissions = { admin: boolean; read: boolean; @@ -901,6 +1260,230 @@ declare namespace Octokit { updated_at: string; url: string; }; + type TeamsListReposLegacyResponseItemPermissions = { + admin: boolean; + pull: boolean; + push: boolean; + }; + type TeamsListReposLegacyResponseItemOwner = { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; + id: number; + login: string; + node_id: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; + url: string; + }; + type TeamsListReposLegacyResponseItemLicense = { + key: string; + name: string; + node_id: string; + spdx_id: string; + url: string; + }; + type TeamsListReposLegacyResponseItem = { + archive_url: string; + archived: boolean; + assignees_url: string; + blobs_url: string; + branches_url: string; + clone_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + created_at: string; + default_branch: string; + deployments_url: string; + description: string; + disabled: boolean; + downloads_url: string; + events_url: string; + fork: boolean; + forks_count: number; + forks_url: string; + full_name: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + has_downloads: boolean; + has_issues: boolean; + has_pages: boolean; + has_projects: boolean; + has_wiki: boolean; + homepage: string; + hooks_url: string; + html_url: string; + id: number; + is_template: boolean; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + language: null; + languages_url: string; + license: TeamsListReposLegacyResponseItemLicense; + merges_url: string; + milestones_url: string; + mirror_url: string; + name: string; + network_count: number; + node_id: string; + notifications_url: string; + open_issues_count: number; + owner: TeamsListReposLegacyResponseItemOwner; + permissions: TeamsListReposLegacyResponseItemPermissions; + private: boolean; + pulls_url: string; + pushed_at: string; + releases_url: string; + size: number; + ssh_url: string; + stargazers_count: number; + stargazers_url: string; + statuses_url: string; + subscribers_count: number; + subscribers_url: string; + subscription_url: string; + svn_url: string; + tags_url: string; + teams_url: string; + temp_clone_token: string; + template_repository: null; + topics: Array; + trees_url: string; + updated_at: string; + url: string; + visibility: string; + watchers_count: number; + }; + type TeamsListReposInOrgResponseItemPermissions = { + admin: boolean; + pull: boolean; + push: boolean; + }; + type TeamsListReposInOrgResponseItemOwner = { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; + id: number; + login: string; + node_id: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; + url: string; + }; + type TeamsListReposInOrgResponseItemLicense = { + key: string; + name: string; + node_id: string; + spdx_id: string; + url: string; + }; + type TeamsListReposInOrgResponseItem = { + archive_url: string; + archived: boolean; + assignees_url: string; + blobs_url: string; + branches_url: string; + clone_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + created_at: string; + default_branch: string; + deployments_url: string; + description: string; + disabled: boolean; + downloads_url: string; + events_url: string; + fork: boolean; + forks_count: number; + forks_url: string; + full_name: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + has_downloads: boolean; + has_issues: boolean; + has_pages: boolean; + has_projects: boolean; + has_wiki: boolean; + homepage: string; + hooks_url: string; + html_url: string; + id: number; + is_template: boolean; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + language: null; + languages_url: string; + license: TeamsListReposInOrgResponseItemLicense; + merges_url: string; + milestones_url: string; + mirror_url: string; + name: string; + network_count: number; + node_id: string; + notifications_url: string; + open_issues_count: number; + owner: TeamsListReposInOrgResponseItemOwner; + permissions: TeamsListReposInOrgResponseItemPermissions; + private: boolean; + pulls_url: string; + pushed_at: string; + releases_url: string; + size: number; + ssh_url: string; + stargazers_count: number; + stargazers_url: string; + statuses_url: string; + subscribers_count: number; + subscribers_url: string; + subscription_url: string; + svn_url: string; + tags_url: string; + teams_url: string; + temp_clone_token: string; + template_repository: null; + topics: Array; + trees_url: string; + updated_at: string; + url: string; + visibility: string; + watchers_count: number; + }; type TeamsListReposResponseItemPermissions = { admin: boolean; pull: boolean; @@ -1004,13 +1587,101 @@ declare namespace Octokit { svn_url: string; tags_url: string; teams_url: string; + temp_clone_token: string; template_repository: null; topics: Array; trees_url: string; updated_at: string; url: string; + visibility: string; watchers_count: number; }; + type TeamsListProjectsLegacyResponseItemPermissions = { + admin: boolean; + read: boolean; + write: boolean; + }; + type TeamsListProjectsLegacyResponseItemCreator = { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; + id: number; + login: string; + node_id: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; + url: string; + }; + type TeamsListProjectsLegacyResponseItem = { + body: string; + columns_url: string; + created_at: string; + creator: TeamsListProjectsLegacyResponseItemCreator; + html_url: string; + id: number; + name: string; + node_id: string; + number: number; + organization_permission: string; + owner_url: string; + permissions: TeamsListProjectsLegacyResponseItemPermissions; + private: boolean; + state: string; + updated_at: string; + url: string; + }; + type TeamsListProjectsInOrgResponseItemPermissions = { + admin: boolean; + read: boolean; + write: boolean; + }; + type TeamsListProjectsInOrgResponseItemCreator = { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; + id: number; + login: string; + node_id: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; + url: string; + }; + type TeamsListProjectsInOrgResponseItem = { + body: string; + columns_url: string; + created_at: string; + creator: TeamsListProjectsInOrgResponseItemCreator; + html_url: string; + id: number; + name: string; + node_id: string; + number: number; + organization_permission: string; + owner_url: string; + permissions: TeamsListProjectsInOrgResponseItemPermissions; + private: boolean; + state: string; + updated_at: string; + url: string; + }; type TeamsListProjectsResponseItemPermissions = { admin: boolean; read: boolean; @@ -1054,6 +1725,66 @@ declare namespace Octokit { updated_at: string; url: string; }; + type TeamsListPendingInvitationsLegacyResponseItemInviter = { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; + id: number; + login: string; + node_id: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; + url: string; + }; + type TeamsListPendingInvitationsLegacyResponseItem = { + created_at: string; + email: string; + id: number; + invitation_team_url: string; + inviter: TeamsListPendingInvitationsLegacyResponseItemInviter; + login: string; + role: string; + team_count: number; + }; + type TeamsListPendingInvitationsInOrgResponseItemInviter = { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; + id: number; + login: string; + node_id: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; + url: string; + }; + type TeamsListPendingInvitationsInOrgResponseItem = { + created_at: string; + email: string; + id: number; + invitation_team_url: string; + inviter: TeamsListPendingInvitationsInOrgResponseItemInviter; + login: string; + role: string; + team_count: number; + }; type TeamsListPendingInvitationsResponseItemInviter = { avatar_url: string; events_url: string; @@ -1084,6 +1815,46 @@ declare namespace Octokit { role: string; team_count: number; }; + type TeamsListMembersLegacyResponseItem = { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; + id: number; + login: string; + node_id: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; + url: string; + }; + type TeamsListMembersInOrgResponseItem = { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; + id: number; + login: string; + node_id: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; + url: string; + }; type TeamsListMembersResponseItem = { avatar_url: string; events_url: string; @@ -1152,6 +1923,106 @@ declare namespace Octokit { updated_at: string; url: string; }; + type TeamsListDiscussionsLegacyResponseItemReactions = { + "+1": number; + "-1": number; + confused: number; + heart: number; + hooray: number; + laugh: number; + total_count: number; + url: string; + }; + type TeamsListDiscussionsLegacyResponseItemAuthor = { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; + id: number; + login: string; + node_id: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; + url: string; + }; + type TeamsListDiscussionsLegacyResponseItem = { + author: TeamsListDiscussionsLegacyResponseItemAuthor; + body: string; + body_html: string; + body_version: string; + comments_count: number; + comments_url: string; + created_at: string; + html_url: string; + last_edited_at: null; + node_id: string; + number: number; + pinned: boolean; + private: boolean; + reactions: TeamsListDiscussionsLegacyResponseItemReactions; + team_url: string; + title: string; + updated_at: string; + url: string; + }; + type TeamsListDiscussionsInOrgResponseItemReactions = { + "+1": number; + "-1": number; + confused: number; + heart: number; + hooray: number; + laugh: number; + total_count: number; + url: string; + }; + type TeamsListDiscussionsInOrgResponseItemAuthor = { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; + id: number; + login: string; + node_id: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; + url: string; + }; + type TeamsListDiscussionsInOrgResponseItem = { + author: TeamsListDiscussionsInOrgResponseItemAuthor; + body: string; + body_html: string; + body_version: string; + comments_count: number; + comments_url: string; + created_at: string; + html_url: string; + last_edited_at: null; + node_id: string; + number: number; + pinned: boolean; + private: boolean; + reactions: TeamsListDiscussionsInOrgResponseItemReactions; + team_url: string; + title: string; + updated_at: string; + url: string; + }; type TeamsListDiscussionsResponseItemReactions = { "+1": number; "-1": number; @@ -1202,6 +2073,96 @@ declare namespace Octokit { updated_at: string; url: string; }; + type TeamsListDiscussionCommentsLegacyResponseItemReactions = { + "+1": number; + "-1": number; + confused: number; + heart: number; + hooray: number; + laugh: number; + total_count: number; + url: string; + }; + type TeamsListDiscussionCommentsLegacyResponseItemAuthor = { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; + id: number; + login: string; + node_id: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; + url: string; + }; + type TeamsListDiscussionCommentsLegacyResponseItem = { + author: TeamsListDiscussionCommentsLegacyResponseItemAuthor; + body: string; + body_html: string; + body_version: string; + created_at: string; + discussion_url: string; + html_url: string; + last_edited_at: null; + node_id: string; + number: number; + reactions: TeamsListDiscussionCommentsLegacyResponseItemReactions; + updated_at: string; + url: string; + }; + type TeamsListDiscussionCommentsInOrgResponseItemReactions = { + "+1": number; + "-1": number; + confused: number; + heart: number; + hooray: number; + laugh: number; + total_count: number; + url: string; + }; + type TeamsListDiscussionCommentsInOrgResponseItemAuthor = { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; + id: number; + login: string; + node_id: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; + url: string; + }; + type TeamsListDiscussionCommentsInOrgResponseItem = { + author: TeamsListDiscussionCommentsInOrgResponseItemAuthor; + body: string; + body_html: string; + body_version: string; + created_at: string; + discussion_url: string; + html_url: string; + last_edited_at: null; + node_id: string; + number: number; + reactions: TeamsListDiscussionCommentsInOrgResponseItemReactions; + updated_at: string; + url: string; + }; type TeamsListDiscussionCommentsResponseItemReactions = { "+1": number; "-1": number; @@ -1247,6 +2208,58 @@ declare namespace Octokit { updated_at: string; url: string; }; + type TeamsListChildLegacyResponseItemParent = { + description: string; + html_url: string; + id: number; + members_url: string; + name: string; + node_id: string; + permission: string; + privacy: string; + repositories_url: string; + slug: string; + url: string; + }; + type TeamsListChildLegacyResponseItem = { + description: string; + id: number; + members_url: string; + name: string; + node_id: string; + parent: TeamsListChildLegacyResponseItemParent; + permission: string; + privacy: string; + repositories_url: string; + slug: string; + url: string; + }; + type TeamsListChildInOrgResponseItemParent = { + description: string; + html_url: string; + id: number; + members_url: string; + name: string; + node_id: string; + permission: string; + privacy: string; + repositories_url: string; + slug: string; + url: string; + }; + type TeamsListChildInOrgResponseItem = { + description: string; + id: number; + members_url: string; + name: string; + node_id: string; + parent: TeamsListChildInOrgResponseItemParent; + permission: string; + privacy: string; + repositories_url: string; + slug: string; + url: string; + }; type TeamsListChildResponseItemParent = { description: string; html_url: string; @@ -1254,7 +2267,6 @@ declare namespace Octokit { members_url: string; name: string; node_id: string; - parent: null; permission: string; privacy: string; repositories_url: string; @@ -1288,11 +2300,259 @@ declare namespace Octokit { slug: string; url: string; }; + type TeamsGetMembershipLegacyResponse = { + role: string; + state: string; + url: string; + }; + type TeamsGetMembershipInOrgResponse = { + role: string; + state: string; + url: string; + }; type TeamsGetMembershipResponse = { role: string; state: string; url: string; }; + type TeamsGetLegacyResponseOrganization = { + avatar_url: string; + blog: string; + company: string; + created_at: string; + description: string; + email: string; + events_url: string; + followers: number; + following: number; + has_organization_projects: boolean; + has_repository_projects: boolean; + hooks_url: string; + html_url: string; + id: number; + is_verified: boolean; + issues_url: string; + location: string; + login: string; + members_url: string; + name: string; + node_id: string; + public_gists: number; + public_members_url: string; + public_repos: number; + repos_url: string; + type: string; + url: string; + }; + type TeamsGetLegacyResponse = { + created_at: string; + description: string; + html_url: string; + id: number; + members_count: number; + members_url: string; + name: string; + node_id: string; + organization: TeamsGetLegacyResponseOrganization; + parent: null; + permission: string; + privacy: string; + repos_count: number; + repositories_url: string; + slug: string; + updated_at: string; + url: string; + }; + type TeamsGetDiscussionLegacyResponseReactions = { + "+1": number; + "-1": number; + confused: number; + heart: number; + hooray: number; + laugh: number; + total_count: number; + url: string; + }; + type TeamsGetDiscussionLegacyResponseAuthor = { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; + id: number; + login: string; + node_id: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; + url: string; + }; + type TeamsGetDiscussionLegacyResponse = { + author: TeamsGetDiscussionLegacyResponseAuthor; + body: string; + body_html: string; + body_version: string; + comments_count: number; + comments_url: string; + created_at: string; + html_url: string; + last_edited_at: null; + node_id: string; + number: number; + pinned: boolean; + private: boolean; + reactions: TeamsGetDiscussionLegacyResponseReactions; + team_url: string; + title: string; + updated_at: string; + url: string; + }; + type TeamsGetDiscussionInOrgResponseReactions = { + "+1": number; + "-1": number; + confused: number; + heart: number; + hooray: number; + laugh: number; + total_count: number; + url: string; + }; + type TeamsGetDiscussionInOrgResponseAuthor = { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; + id: number; + login: string; + node_id: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; + url: string; + }; + type TeamsGetDiscussionInOrgResponse = { + author: TeamsGetDiscussionInOrgResponseAuthor; + body: string; + body_html: string; + body_version: string; + comments_count: number; + comments_url: string; + created_at: string; + html_url: string; + last_edited_at: null; + node_id: string; + number: number; + pinned: boolean; + private: boolean; + reactions: TeamsGetDiscussionInOrgResponseReactions; + team_url: string; + title: string; + updated_at: string; + url: string; + }; + type TeamsGetDiscussionCommentLegacyResponseReactions = { + "+1": number; + "-1": number; + confused: number; + heart: number; + hooray: number; + laugh: number; + total_count: number; + url: string; + }; + type TeamsGetDiscussionCommentLegacyResponseAuthor = { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; + id: number; + login: string; + node_id: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; + url: string; + }; + type TeamsGetDiscussionCommentLegacyResponse = { + author: TeamsGetDiscussionCommentLegacyResponseAuthor; + body: string; + body_html: string; + body_version: string; + created_at: string; + discussion_url: string; + html_url: string; + last_edited_at: null; + node_id: string; + number: number; + reactions: TeamsGetDiscussionCommentLegacyResponseReactions; + updated_at: string; + url: string; + }; + type TeamsGetDiscussionCommentInOrgResponseReactions = { + "+1": number; + "-1": number; + confused: number; + heart: number; + hooray: number; + laugh: number; + total_count: number; + url: string; + }; + type TeamsGetDiscussionCommentInOrgResponseAuthor = { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; + id: number; + login: string; + node_id: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; + url: string; + }; + type TeamsGetDiscussionCommentInOrgResponse = { + author: TeamsGetDiscussionCommentInOrgResponseAuthor; + body: string; + body_html: string; + body_version: string; + created_at: string; + discussion_url: string; + html_url: string; + last_edited_at: null; + node_id: string; + number: number; + reactions: TeamsGetDiscussionCommentInOrgResponseReactions; + updated_at: string; + url: string; + }; type TeamsGetDiscussionCommentResponseReactions = { "+1": number; "-1": number; @@ -1484,6 +2744,196 @@ declare namespace Octokit { updated_at: string; url: string; }; + type TeamsCreateDiscussionLegacyResponseReactions = { + "+1": number; + "-1": number; + confused: number; + heart: number; + hooray: number; + laugh: number; + total_count: number; + url: string; + }; + type TeamsCreateDiscussionLegacyResponseAuthor = { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; + id: number; + login: string; + node_id: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; + url: string; + }; + type TeamsCreateDiscussionLegacyResponse = { + author: TeamsCreateDiscussionLegacyResponseAuthor; + body: string; + body_html: string; + body_version: string; + comments_count: number; + comments_url: string; + created_at: string; + html_url: string; + last_edited_at: null; + node_id: string; + number: number; + pinned: boolean; + private: boolean; + reactions: TeamsCreateDiscussionLegacyResponseReactions; + team_url: string; + title: string; + updated_at: string; + url: string; + }; + type TeamsCreateDiscussionInOrgResponseReactions = { + "+1": number; + "-1": number; + confused: number; + heart: number; + hooray: number; + laugh: number; + total_count: number; + url: string; + }; + type TeamsCreateDiscussionInOrgResponseAuthor = { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; + id: number; + login: string; + node_id: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; + url: string; + }; + type TeamsCreateDiscussionInOrgResponse = { + author: TeamsCreateDiscussionInOrgResponseAuthor; + body: string; + body_html: string; + body_version: string; + comments_count: number; + comments_url: string; + created_at: string; + html_url: string; + last_edited_at: null; + node_id: string; + number: number; + pinned: boolean; + private: boolean; + reactions: TeamsCreateDiscussionInOrgResponseReactions; + team_url: string; + title: string; + updated_at: string; + url: string; + }; + type TeamsCreateDiscussionCommentLegacyResponseReactions = { + "+1": number; + "-1": number; + confused: number; + heart: number; + hooray: number; + laugh: number; + total_count: number; + url: string; + }; + type TeamsCreateDiscussionCommentLegacyResponseAuthor = { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; + id: number; + login: string; + node_id: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; + url: string; + }; + type TeamsCreateDiscussionCommentLegacyResponse = { + author: TeamsCreateDiscussionCommentLegacyResponseAuthor; + body: string; + body_html: string; + body_version: string; + created_at: string; + discussion_url: string; + html_url: string; + last_edited_at: null; + node_id: string; + number: number; + reactions: TeamsCreateDiscussionCommentLegacyResponseReactions; + updated_at: string; + url: string; + }; + type TeamsCreateDiscussionCommentInOrgResponseReactions = { + "+1": number; + "-1": number; + confused: number; + heart: number; + hooray: number; + laugh: number; + total_count: number; + url: string; + }; + type TeamsCreateDiscussionCommentInOrgResponseAuthor = { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; + id: number; + login: string; + node_id: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; + url: string; + }; + type TeamsCreateDiscussionCommentInOrgResponse = { + author: TeamsCreateDiscussionCommentInOrgResponseAuthor; + body: string; + body_html: string; + body_version: string; + created_at: string; + discussion_url: string; + html_url: string; + last_edited_at: null; + node_id: string; + number: number; + reactions: TeamsCreateDiscussionCommentInOrgResponseReactions; + updated_at: string; + url: string; + }; type TeamsCreateDiscussionCommentResponseReactions = { "+1": number; "-1": number; @@ -1627,6 +3077,220 @@ declare namespace Octokit { updated_at: string; url: string; }; + type TeamsCheckManagesRepoLegacyResponsePermissions = { + admin: boolean; + pull: boolean; + push: boolean; + }; + type TeamsCheckManagesRepoLegacyResponseOwner = { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; + id: number; + login: string; + node_id: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; + url: string; + }; + type TeamsCheckManagesRepoLegacyResponse = { + allow_merge_commit: boolean; + allow_rebase_merge: boolean; + allow_squash_merge: boolean; + archive_url: string; + archived: boolean; + assignees_url: string; + blobs_url: string; + branches_url: string; + clone_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + created_at: string; + default_branch: string; + deployments_url: string; + description: string; + disabled: boolean; + downloads_url: string; + events_url: string; + fork: boolean; + forks_count: number; + forks_url: string; + full_name: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + has_downloads: boolean; + has_issues: boolean; + has_pages: boolean; + has_projects: boolean; + has_wiki: boolean; + homepage: string; + hooks_url: string; + html_url: string; + id: number; + is_template: boolean; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + language: null; + languages_url: string; + merges_url: string; + milestones_url: string; + mirror_url: string; + name: string; + network_count: number; + node_id: string; + notifications_url: string; + open_issues_count: number; + owner: TeamsCheckManagesRepoLegacyResponseOwner; + permissions: TeamsCheckManagesRepoLegacyResponsePermissions; + private: boolean; + pulls_url: string; + pushed_at: string; + releases_url: string; + size: number; + ssh_url: string; + stargazers_count: number; + stargazers_url: string; + statuses_url: string; + subscribers_count: number; + subscribers_url: string; + subscription_url: string; + svn_url: string; + tags_url: string; + teams_url: string; + temp_clone_token: string; + template_repository: null; + topics: Array; + trees_url: string; + updated_at: string; + url: string; + visibility: string; + watchers_count: number; + }; + type TeamsCheckManagesRepoInOrgResponsePermissions = { + admin: boolean; + pull: boolean; + push: boolean; + }; + type TeamsCheckManagesRepoInOrgResponseOwner = { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; + id: number; + login: string; + node_id: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; + url: string; + }; + type TeamsCheckManagesRepoInOrgResponse = { + allow_merge_commit: boolean; + allow_rebase_merge: boolean; + allow_squash_merge: boolean; + archive_url: string; + archived: boolean; + assignees_url: string; + blobs_url: string; + branches_url: string; + clone_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + created_at: string; + default_branch: string; + deployments_url: string; + description: string; + disabled: boolean; + downloads_url: string; + events_url: string; + fork: boolean; + forks_count: number; + forks_url: string; + full_name: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + has_downloads: boolean; + has_issues: boolean; + has_pages: boolean; + has_projects: boolean; + has_wiki: boolean; + homepage: string; + hooks_url: string; + html_url: string; + id: number; + is_template: boolean; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + language: null; + languages_url: string; + merges_url: string; + milestones_url: string; + mirror_url: string; + name: string; + network_count: number; + node_id: string; + notifications_url: string; + open_issues_count: number; + owner: TeamsCheckManagesRepoInOrgResponseOwner; + permissions: TeamsCheckManagesRepoInOrgResponsePermissions; + private: boolean; + pulls_url: string; + pushed_at: string; + releases_url: string; + size: number; + ssh_url: string; + stargazers_count: number; + stargazers_url: string; + statuses_url: string; + subscribers_count: number; + subscribers_url: string; + subscription_url: string; + svn_url: string; + tags_url: string; + teams_url: string; + temp_clone_token: string; + template_repository: null; + topics: Array; + trees_url: string; + updated_at: string; + url: string; + visibility: string; + watchers_count: number; + }; type TeamsCheckManagesRepoResponsePermissions = { admin: boolean; pull: boolean; @@ -1725,22 +3389,51 @@ declare namespace Octokit { svn_url: string; tags_url: string; teams_url: string; + temp_clone_token: string; template_repository: null; topics: Array; trees_url: string; updated_at: string; url: string; + visibility: string; watchers_count: number; }; + type TeamsAddOrUpdateProjectLegacyResponse = { + documentation_url: string; + message: string; + }; + type TeamsAddOrUpdateProjectInOrgResponse = { + documentation_url: string; + message: string; + }; type TeamsAddOrUpdateProjectResponse = { documentation_url: string; message: string; }; + type TeamsAddOrUpdateMembershipLegacyResponse = { + role: string; + state: string; + url: string; + }; + type TeamsAddOrUpdateMembershipInOrgResponse = { + role: string; + state: string; + url: string; + }; type TeamsAddOrUpdateMembershipResponse = { role: string; state: string; url: string; }; + type TeamsAddMemberLegacyResponseErrorsItem = { + code: string; + field: string; + resource: string; + }; + type TeamsAddMemberLegacyResponse = { + errors: Array; + message: string; + }; type TeamsAddMemberResponseErrorsItem = { code: string; field: string; @@ -1750,6 +3443,27 @@ declare namespace Octokit { errors: Array; message: string; }; + type SearchUsersLegacyResponseUsersItem = { + created: string; + created_at: string; + followers: number; + followers_count: number; + fullname: string; + gravatar_id: string; + id: string; + language: string; + location: string; + login: string; + name: string; + public_repo_count: number; + repos: number; + score: number; + type: string; + username: string; + }; + type SearchUsersLegacyResponse = { + users: Array; + }; type SearchUsersResponseItemsItem = { avatar_url: string; followers_url: string; @@ -1789,6 +3503,34 @@ declare namespace Octokit { items: Array; total_count: number; }; + type SearchReposLegacyResponseRepositoriesItem = { + created: string; + created_at: string; + description: string; + followers: number; + fork: boolean; + forks: number; + has_downloads: boolean; + has_issues: boolean; + has_wiki: boolean; + homepage: string; + language: string; + name: string; + open_issues: number; + owner: string; + private: boolean; + pushed: string; + pushed_at: string; + score: number; + size: number; + type: string; + url: string; + username: string; + watchers: number; + }; + type SearchReposLegacyResponse = { + repositories: Array; + }; type SearchReposResponseItemsItemOwner = { avatar_url: string; gravatar_id: string; @@ -1844,6 +3586,24 @@ declare namespace Octokit { items: Array; total_count: number; }; + type SearchIssuesLegacyResponseIssuesItem = { + body: string; + comments: number; + created_at: string; + gravatar_id: string; + html_url: string; + labels: Array; + number: number; + position: number; + state: string; + title: string; + updated_at: string; + user: string; + votes: number; + }; + type SearchIssuesLegacyResponse = { + issues: Array; + }; type SearchIssuesAndPullRequestsResponseItemsItemUser = { avatar_url: string; events_url: string; @@ -1964,6 +3724,24 @@ declare namespace Octokit { items: Array; total_count: number; }; + type SearchEmailLegacyResponseUser = { + blog: string; + company: string; + created: string; + created_at: string; + email: string; + followers_count: number; + following_count: number; + gravatar_id: string; + id: number; + location: string; + login: string; + name: string; + public_gist_count: number; + public_repo_count: number; + type: string; + }; + type SearchEmailLegacyResponse = { user: SearchEmailLegacyResponseUser }; type SearchCommitsResponseItemsItemRepositoryOwner = { avatar_url: string; events_url: string; @@ -2767,12 +4545,22 @@ declare namespace Octokit { required_approving_review_count: number; url: string; }; + type ReposUpdateBranchProtectionResponseRequiredLinearHistory = { + enabled: boolean; + }; type ReposUpdateBranchProtectionResponseEnforceAdmins = { enabled: boolean; url: string; }; + type ReposUpdateBranchProtectionResponseAllowForcePushes = { + enabled: boolean; + }; + type ReposUpdateBranchProtectionResponseAllowDeletions = { enabled: boolean }; type ReposUpdateBranchProtectionResponse = { + allow_deletions: ReposUpdateBranchProtectionResponseAllowDeletions; + allow_force_pushes: ReposUpdateBranchProtectionResponseAllowForcePushes; enforce_admins: ReposUpdateBranchProtectionResponseEnforceAdmins; + required_linear_history: ReposUpdateBranchProtectionResponseRequiredLinearHistory; required_pull_request_reviews: ReposUpdateBranchProtectionResponseRequiredPullRequestReviews; required_status_checks: ReposUpdateBranchProtectionResponseRequiredStatusChecks; restrictions: ReposUpdateBranchProtectionResponseRestrictions; @@ -2876,11 +4664,13 @@ declare namespace Octokit { svn_url: string; tags_url: string; teams_url: string; + temp_clone_token: string; template_repository: null; topics: Array; trees_url: string; updated_at: string; url: string; + visibility: string; watchers_count: number; }; type ReposUpdateResponsePermissions = { @@ -2986,11 +4776,13 @@ declare namespace Octokit { svn_url: string; tags_url: string; teams_url: string; + temp_clone_token: string; template_repository: null; topics: Array; trees_url: string; updated_at: string; url: string; + visibility: string; watchers_count: number; }; type ReposUpdateResponseOwner = { @@ -3109,11 +4901,13 @@ declare namespace Octokit { svn_url: string; tags_url: string; teams_url: string; + temp_clone_token: string; template_repository: null; topics: Array; trees_url: string; updated_at: string; url: string; + visibility: string; watchers_count: number; }; type ReposTransferResponsePermissions = { @@ -3214,11 +5008,13 @@ declare namespace Octokit { svn_url: string; tags_url: string; teams_url: string; + temp_clone_token: string; template_repository: null; topics: Array; trees_url: string; updated_at: string; url: string; + visibility: string; watchers_count: number; }; type ReposRetrieveCommunityProfileMetricsResponseFilesReadme = { @@ -3864,11 +5660,13 @@ declare namespace Octokit { svn_url: string; tags_url: string; teams_url: string; + temp_clone_token: string; template_repository: null; topics: Array; trees_url: string; updated_at: string; url: string; + visibility: string; watchers_count: number; }; type ReposListPullRequestsAssociatedWithCommitResponseItemHead = { @@ -3996,11 +5794,13 @@ declare namespace Octokit { svn_url: string; tags_url: string; teams_url: string; + temp_clone_token: string; template_repository: null; topics: Array; trees_url: string; updated_at: string; url: string; + visibility: string; watchers_count: number; }; type ReposListPullRequestsAssociatedWithCommitResponseItemBase = { @@ -4629,11 +6429,13 @@ declare namespace Octokit { svn_url: string; tags_url: string; teams_url: string; + temp_clone_token: string; template_repository: null; topics: Array; trees_url: string; updated_at: string; url: string; + visibility: string; watchers_count: number; }; type ReposListForOrgResponseItemPermissions = { @@ -4739,11 +6541,13 @@ declare namespace Octokit { svn_url: string; tags_url: string; teams_url: string; + temp_clone_token: string; template_repository: null; topics: Array; trees_url: string; updated_at: string; url: string; + visibility: string; watchers_count: number; }; type ReposListDownloadsResponseItem = { @@ -6263,12 +8067,20 @@ declare namespace Octokit { required_approving_review_count: number; url: string; }; + type ReposGetBranchProtectionResponseRequiredLinearHistory = { + enabled: boolean; + }; type ReposGetBranchProtectionResponseEnforceAdmins = { enabled: boolean; url: string; }; + type ReposGetBranchProtectionResponseAllowForcePushes = { enabled: boolean }; + type ReposGetBranchProtectionResponseAllowDeletions = { enabled: boolean }; type ReposGetBranchProtectionResponse = { + allow_deletions: ReposGetBranchProtectionResponseAllowDeletions; + allow_force_pushes: ReposGetBranchProtectionResponseAllowForcePushes; enforce_admins: ReposGetBranchProtectionResponseEnforceAdmins; + required_linear_history: ReposGetBranchProtectionResponseRequiredLinearHistory; required_pull_request_reviews: ReposGetBranchProtectionResponseRequiredPullRequestReviews; required_status_checks: ReposGetBranchProtectionResponseRequiredStatusChecks; restrictions: ReposGetBranchProtectionResponseRestrictions; @@ -6472,11 +8284,13 @@ declare namespace Octokit { svn_url: string; tags_url: string; teams_url: string; + temp_clone_token: string; template_repository: null; topics: Array; trees_url: string; updated_at: string; url: string; + visibility: string; watchers_count: number; }; type ReposGetResponsePermissions = { @@ -6582,11 +8396,13 @@ declare namespace Octokit { svn_url: string; tags_url: string; teams_url: string; + temp_clone_token: string; template_repository: null; topics: Array; trees_url: string; updated_at: string; url: string; + visibility: string; watchers_count: number; }; type ReposGetResponseOwner = { @@ -6713,11 +8529,13 @@ declare namespace Octokit { svn_url: string; tags_url: string; teams_url: string; + temp_clone_token: string; template_repository: null; topics: Array; trees_url: string; updated_at: string; url: string; + visibility: string; watchers_count: number; }; type ReposEnablePagesSiteResponseSource = { @@ -6869,11 +8687,13 @@ declare namespace Octokit { svn_url: string; tags_url: string; teams_url: string; + temp_clone_token: string; template_repository: null; topics: Array; trees_url: string; updated_at: string; url: string; + visibility: string; watchers_count: number; }; type ReposCreateUsingTemplateResponsePermissions = { @@ -6974,11 +8794,13 @@ declare namespace Octokit { svn_url: string; tags_url: string; teams_url: string; + temp_clone_token: string; template_repository: ReposCreateUsingTemplateResponseTemplateRepository; topics: Array; trees_url: string; updated_at: string; url: string; + visibility: string; watchers_count: number; }; type ReposCreateStatusResponseCreator = { @@ -7207,11 +9029,13 @@ declare namespace Octokit { svn_url: string; tags_url: string; teams_url: string; + temp_clone_token: string; template_repository: null; topics: Array; trees_url: string; updated_at: string; url: string; + visibility: string; watchers_count: number; }; type ReposCreateHookResponseLastResponse = { @@ -7336,11 +9160,13 @@ declare namespace Octokit { svn_url: string; tags_url: string; teams_url: string; + temp_clone_token: string; template_repository: null; topics: Array; trees_url: string; updated_at: string; url: string; + visibility: string; watchers_count: number; }; type ReposCreateForAuthenticatedUserResponsePermissions = { @@ -7441,11 +9267,13 @@ declare namespace Octokit { svn_url: string; tags_url: string; teams_url: string; + temp_clone_token: string; template_repository: null; topics: Array; trees_url: string; updated_at: string; url: string; + visibility: string; watchers_count: number; }; type ReposCreateFileResponseContentLinks = { @@ -8096,6 +9924,114 @@ declare namespace Octokit { repository: ReposAddCollaboratorResponseRepository; url: string; }; + type ReactionsListForTeamDiscussionLegacyResponseItemUser = { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; + id: number; + login: string; + node_id: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; + url: string; + }; + type ReactionsListForTeamDiscussionLegacyResponseItem = { + content: string; + created_at: string; + id: number; + node_id: string; + user: ReactionsListForTeamDiscussionLegacyResponseItemUser; + }; + type ReactionsListForTeamDiscussionInOrgResponseItemUser = { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; + id: number; + login: string; + node_id: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; + url: string; + }; + type ReactionsListForTeamDiscussionInOrgResponseItem = { + content: string; + created_at: string; + id: number; + node_id: string; + user: ReactionsListForTeamDiscussionInOrgResponseItemUser; + }; + type ReactionsListForTeamDiscussionCommentLegacyResponseItemUser = { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; + id: number; + login: string; + node_id: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; + url: string; + }; + type ReactionsListForTeamDiscussionCommentLegacyResponseItem = { + content: string; + created_at: string; + id: number; + node_id: string; + user: ReactionsListForTeamDiscussionCommentLegacyResponseItemUser; + }; + type ReactionsListForTeamDiscussionCommentInOrgResponseItemUser = { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; + id: number; + login: string; + node_id: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; + url: string; + }; + type ReactionsListForTeamDiscussionCommentInOrgResponseItem = { + content: string; + created_at: string; + id: number; + node_id: string; + user: ReactionsListForTeamDiscussionCommentInOrgResponseItemUser; + }; type ReactionsListForTeamDiscussionCommentResponseItemUser = { avatar_url: string; events_url: string; @@ -8258,6 +10194,114 @@ declare namespace Octokit { node_id: string; user: ReactionsListForCommitCommentResponseItemUser; }; + type ReactionsCreateForTeamDiscussionLegacyResponseUser = { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; + id: number; + login: string; + node_id: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; + url: string; + }; + type ReactionsCreateForTeamDiscussionLegacyResponse = { + content: string; + created_at: string; + id: number; + node_id: string; + user: ReactionsCreateForTeamDiscussionLegacyResponseUser; + }; + type ReactionsCreateForTeamDiscussionInOrgResponseUser = { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; + id: number; + login: string; + node_id: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; + url: string; + }; + type ReactionsCreateForTeamDiscussionInOrgResponse = { + content: string; + created_at: string; + id: number; + node_id: string; + user: ReactionsCreateForTeamDiscussionInOrgResponseUser; + }; + type ReactionsCreateForTeamDiscussionCommentLegacyResponseUser = { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; + id: number; + login: string; + node_id: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; + url: string; + }; + type ReactionsCreateForTeamDiscussionCommentLegacyResponse = { + content: string; + created_at: string; + id: number; + node_id: string; + user: ReactionsCreateForTeamDiscussionCommentLegacyResponseUser; + }; + type ReactionsCreateForTeamDiscussionCommentInOrgResponseUser = { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; + id: number; + login: string; + node_id: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; + url: string; + }; + type ReactionsCreateForTeamDiscussionCommentInOrgResponse = { + content: string; + created_at: string; + id: number; + node_id: string; + user: ReactionsCreateForTeamDiscussionCommentInOrgResponseUser; + }; type ReactionsCreateForTeamDiscussionCommentResponseUser = { avatar_url: string; events_url: string; @@ -8787,11 +10831,13 @@ declare namespace Octokit { svn_url: string; tags_url: string; teams_url: string; + temp_clone_token: string; template_repository: null; topics: Array; trees_url: string; updated_at: string; url: string; + visibility: string; watchers_count: number; }; type PullsUpdateResponseHead = { @@ -8919,11 +10965,13 @@ declare namespace Octokit { svn_url: string; tags_url: string; teams_url: string; + temp_clone_token: string; template_repository: null; topics: Array; trees_url: string; updated_at: string; url: string; + visibility: string; watchers_count: number; }; type PullsUpdateResponseBase = { @@ -9075,6 +11123,7 @@ declare namespace Octokit { node_id: string; pull_request_url: string; state: string; + submitted_at: string; user: PullsSubmitReviewResponseUser; }; type PullsMergeResponse = { merged: boolean; message: string; sha: string }; @@ -9113,6 +11162,7 @@ declare namespace Octokit { node_id: string; pull_request_url: string; state: string; + submitted_at: string; user: PullsListReviewsResponseItemUser; }; type PullsListReviewRequestsResponseUsersItem = { @@ -9572,11 +11622,13 @@ declare namespace Octokit { svn_url: string; tags_url: string; teams_url: string; + temp_clone_token: string; template_repository: null; topics: Array; trees_url: string; updated_at: string; url: string; + visibility: string; watchers_count: number; }; type PullsListResponseItemHead = { @@ -9704,11 +11756,13 @@ declare namespace Octokit { svn_url: string; tags_url: string; teams_url: string; + temp_clone_token: string; template_repository: null; topics: Array; trees_url: string; updated_at: string; url: string; + visibility: string; watchers_count: number; }; type PullsListResponseItemBase = { @@ -9848,6 +11902,7 @@ declare namespace Octokit { node_id: string; pull_request_url: string; state: string; + submitted_at: string; user: PullsGetReviewResponseUser; }; type PullsGetCommentsForReviewResponseItemUser = { @@ -10193,11 +12248,13 @@ declare namespace Octokit { svn_url: string; tags_url: string; teams_url: string; + temp_clone_token: string; template_repository: null; topics: Array; trees_url: string; updated_at: string; url: string; + visibility: string; watchers_count: number; }; type PullsGetResponseHead = { @@ -10325,11 +12382,13 @@ declare namespace Octokit { svn_url: string; tags_url: string; teams_url: string; + temp_clone_token: string; template_repository: null; topics: Array; trees_url: string; updated_at: string; url: string; + visibility: string; watchers_count: number; }; type PullsGetResponseBase = { @@ -10739,11 +12798,13 @@ declare namespace Octokit { svn_url: string; tags_url: string; teams_url: string; + temp_clone_token: string; template_repository: null; topics: Array; trees_url: string; updated_at: string; url: string; + visibility: string; watchers_count: number; }; type PullsCreateReviewRequestResponseHead = { @@ -10871,11 +12932,13 @@ declare namespace Octokit { svn_url: string; tags_url: string; teams_url: string; + temp_clone_token: string; template_repository: null; topics: Array; trees_url: string; updated_at: string; url: string; + visibility: string; watchers_count: number; }; type PullsCreateReviewRequestResponseBase = { @@ -11306,11 +13369,13 @@ declare namespace Octokit { svn_url: string; tags_url: string; teams_url: string; + temp_clone_token: string; template_repository: null; topics: Array; trees_url: string; updated_at: string; url: string; + visibility: string; watchers_count: number; }; type PullsCreateFromIssueResponseHead = { @@ -11438,11 +13503,13 @@ declare namespace Octokit { svn_url: string; tags_url: string; teams_url: string; + temp_clone_token: string; template_repository: null; topics: Array; trees_url: string; updated_at: string; url: string; + visibility: string; watchers_count: number; }; type PullsCreateFromIssueResponseBase = { @@ -11910,11 +13977,13 @@ declare namespace Octokit { svn_url: string; tags_url: string; teams_url: string; + temp_clone_token: string; template_repository: null; topics: Array; trees_url: string; updated_at: string; url: string; + visibility: string; watchers_count: number; }; type PullsCreateResponseHead = { @@ -12042,11 +14111,13 @@ declare namespace Octokit { svn_url: string; tags_url: string; teams_url: string; + temp_clone_token: string; template_repository: null; topics: Array; trees_url: string; updated_at: string; url: string; + visibility: string; watchers_count: number; }; type PullsCreateResponseBase = { @@ -12725,7 +14796,7 @@ declare namespace Octokit { collaborators: number; company: string; created_at: string; - default_repository_settings: string; + default_repository_permission: string; description: string; disk_usage: number; email: string; @@ -12742,6 +14813,9 @@ declare namespace Octokit { location: string; login: string; members_allowed_repository_creation_type: string; + members_can_create_internal_repositories: boolean; + members_can_create_private_repositories: boolean; + members_can_create_public_repositories: boolean; members_can_create_repositories: boolean; members_url: string; name: string; @@ -13138,7 +15212,7 @@ declare namespace Octokit { collaborators?: number; company: string; created_at: string; - default_repository_settings?: string; + default_repository_permission?: string; description: string; disk_usage?: number; email: string; @@ -13155,6 +15229,9 @@ declare namespace Octokit { location: string; login: string; members_allowed_repository_creation_type?: string; + members_can_create_internal_repositories?: boolean; + members_can_create_private_repositories?: boolean; + members_can_create_public_repositories?: boolean; members_can_create_repositories?: boolean; members_url: string; name: string; @@ -13631,11 +15708,13 @@ declare namespace Octokit { svn_url: string; tags_url: string; teams_url: string; + temp_clone_token: string; template_repository: null; topics: Array; trees_url: string; updated_at: string; url: string; + visibility: string; watchers_count: number; }; type MigrationsStartForOrgResponseOwner = { @@ -13762,11 +15841,13 @@ declare namespace Octokit { svn_url: string; tags_url: string; teams_url: string; + temp_clone_token: string; template_repository: null; topics: Array; trees_url: string; updated_at: string; url: string; + visibility: string; watchers_count: number; }; type MigrationsStartForAuthenticatedUserResponseOwner = { @@ -13827,6 +15908,230 @@ declare namespace Octokit { remote_name: string; url: string; }; + type MigrationsListReposForUserResponseItemPermissions = { + admin: boolean; + pull: boolean; + push: boolean; + }; + type MigrationsListReposForUserResponseItemOwner = { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; + id: number; + login: string; + node_id: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; + url: string; + }; + type MigrationsListReposForUserResponseItemLicense = { + key: string; + name: string; + node_id: string; + spdx_id: string; + url: string; + }; + type MigrationsListReposForUserResponseItem = { + archive_url: string; + archived: boolean; + assignees_url: string; + blobs_url: string; + branches_url: string; + clone_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + created_at: string; + default_branch: string; + deployments_url: string; + description: string; + disabled: boolean; + downloads_url: string; + events_url: string; + fork: boolean; + forks_count: number; + forks_url: string; + full_name: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + has_downloads: boolean; + has_issues: boolean; + has_pages: boolean; + has_projects: boolean; + has_wiki: boolean; + homepage: string; + hooks_url: string; + html_url: string; + id: number; + is_template: boolean; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + language: null; + languages_url: string; + license: MigrationsListReposForUserResponseItemLicense; + merges_url: string; + milestones_url: string; + mirror_url: string; + name: string; + network_count: number; + node_id: string; + notifications_url: string; + open_issues_count: number; + owner: MigrationsListReposForUserResponseItemOwner; + permissions: MigrationsListReposForUserResponseItemPermissions; + private: boolean; + pulls_url: string; + pushed_at: string; + releases_url: string; + size: number; + ssh_url: string; + stargazers_count: number; + stargazers_url: string; + statuses_url: string; + subscribers_count: number; + subscribers_url: string; + subscription_url: string; + svn_url: string; + tags_url: string; + teams_url: string; + temp_clone_token: string; + template_repository: null; + topics: Array; + trees_url: string; + updated_at: string; + url: string; + visibility: string; + watchers_count: number; + }; + type MigrationsListReposForOrgResponseItemPermissions = { + admin: boolean; + pull: boolean; + push: boolean; + }; + type MigrationsListReposForOrgResponseItemOwner = { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; + id: number; + login: string; + node_id: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; + url: string; + }; + type MigrationsListReposForOrgResponseItemLicense = { + key: string; + name: string; + node_id: string; + spdx_id: string; + url: string; + }; + type MigrationsListReposForOrgResponseItem = { + archive_url: string; + archived: boolean; + assignees_url: string; + blobs_url: string; + branches_url: string; + clone_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + created_at: string; + default_branch: string; + deployments_url: string; + description: string; + disabled: boolean; + downloads_url: string; + events_url: string; + fork: boolean; + forks_count: number; + forks_url: string; + full_name: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + has_downloads: boolean; + has_issues: boolean; + has_pages: boolean; + has_projects: boolean; + has_wiki: boolean; + homepage: string; + hooks_url: string; + html_url: string; + id: number; + is_template: boolean; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + language: null; + languages_url: string; + license: MigrationsListReposForOrgResponseItemLicense; + merges_url: string; + milestones_url: string; + mirror_url: string; + name: string; + network_count: number; + node_id: string; + notifications_url: string; + open_issues_count: number; + owner: MigrationsListReposForOrgResponseItemOwner; + permissions: MigrationsListReposForOrgResponseItemPermissions; + private: boolean; + pulls_url: string; + pushed_at: string; + releases_url: string; + size: number; + ssh_url: string; + stargazers_count: number; + stargazers_url: string; + statuses_url: string; + subscribers_count: number; + subscribers_url: string; + subscription_url: string; + svn_url: string; + tags_url: string; + teams_url: string; + temp_clone_token: string; + template_repository: null; + topics: Array; + trees_url: string; + updated_at: string; + url: string; + visibility: string; + watchers_count: number; + }; type MigrationsListForOrgResponseItemRepositoriesItemPermissions = { admin: boolean; pull: boolean; @@ -13925,11 +16230,13 @@ declare namespace Octokit { svn_url: string; tags_url: string; teams_url: string; + temp_clone_token: string; template_repository: null; topics: Array; trees_url: string; updated_at: string; url: string; + visibility: string; watchers_count: number; }; type MigrationsListForOrgResponseItemOwner = { @@ -14056,11 +16363,13 @@ declare namespace Octokit { svn_url: string; tags_url: string; teams_url: string; + temp_clone_token: string; template_repository: null; topics: Array; trees_url: string; updated_at: string; url: string; + visibility: string; watchers_count: number; }; type MigrationsListForAuthenticatedUserResponseItemOwner = { @@ -14195,11 +16504,13 @@ declare namespace Octokit { svn_url: string; tags_url: string; teams_url: string; + temp_clone_token: string; template_repository: null; topics: Array; trees_url: string; updated_at: string; url: string; + visibility: string; watchers_count: number; }; type MigrationsGetStatusForOrgResponseOwner = { @@ -14326,11 +16637,13 @@ declare namespace Octokit { svn_url: string; tags_url: string; teams_url: string; + temp_clone_token: string; template_repository: null; topics: Array; trees_url: string; updated_at: string; url: string; + visibility: string; watchers_count: number; }; type MigrationsGetStatusForAuthenticatedUserResponseOwner = { @@ -14397,12 +16710,21 @@ declare namespace Octokit { remote_name: string; url: string; }; + type MetaGetResponseSshKeyFingerprints = { + MD5_DSA: string; + MD5_RSA: string; + SHA256_DSA: string; + SHA256_RSA: string; + }; type MetaGetResponse = { + api: Array; git: Array; hooks: Array; importer: Array; pages: Array; + ssh_key_fingerprints: MetaGetResponseSshKeyFingerprints; verifiable_password_authentication: boolean; + web: Array; }; type LicensesListCommonlyUsedResponseItem = { key: string; @@ -15176,11 +17498,13 @@ declare namespace Octokit { svn_url: string; tags_url: string; teams_url: string; + temp_clone_token: string; template_repository: null; topics: Array; trees_url: string; updated_at: string; url: string; + visibility: string; watchers_count: number; }; type IssuesListForOrgResponseItemPullRequest = { @@ -15421,11 +17745,13 @@ declare namespace Octokit { svn_url: string; tags_url: string; teams_url: string; + temp_clone_token: string; template_repository: null; topics: Array; trees_url: string; updated_at: string; url: string; + visibility: string; watchers_count: number; }; type IssuesListForAuthenticatedUserResponseItemPullRequest = { @@ -15976,11 +18302,13 @@ declare namespace Octokit { svn_url: string; tags_url: string; teams_url: string; + temp_clone_token: string; template_repository: null; topics: Array; trees_url: string; updated_at: string; url: string; + visibility: string; watchers_count: number; }; type IssuesListResponseItemPullRequest = { @@ -16934,6 +19262,20 @@ declare namespace Octokit { ref: string; url: string; }; + type GitGetTreeResponseTreeItem = { + mode: string; + path: string; + sha: string; + size?: number; + type: string; + url: string; + }; + type GitGetTreeResponse = { + sha: string; + tree: Array; + truncated: boolean; + url: string; + }; type GitGetTagResponseVerification = { payload: null; reason: string; @@ -18265,11 +20607,13 @@ declare namespace Octokit { svn_url: string; tags_url: string; teams_url: string; + temp_clone_token: string; template_repository: null; topics: Array; trees_url: string; updated_at: string; url: string; + visibility: string; watchers_count: number; }; type ChecksSetSuitesPreferencesResponsePreferencesAutoTriggerChecksItem = { @@ -18383,11 +20727,13 @@ declare namespace Octokit { svn_url: string; tags_url: string; teams_url: string; + temp_clone_token: string; template_repository: null; topics: Array; trees_url: string; updated_at: string; url: string; + visibility: string; watchers_count: number; }; type ChecksListSuitesForRefResponseCheckSuitesItemAppPermissions = { @@ -18735,11 +21081,13 @@ declare namespace Octokit { svn_url: string; tags_url: string; teams_url: string; + temp_clone_token: string; template_repository: null; topics: Array; trees_url: string; updated_at: string; url: string; + visibility: string; watchers_count: number; }; type ChecksGetSuiteResponseAppPermissions = { @@ -18975,11 +21323,13 @@ declare namespace Octokit { svn_url: string; tags_url: string; teams_url: string; + temp_clone_token: string; template_repository: null; topics: Array; trees_url: string; updated_at: string; url: string; + visibility: string; watchers_count: number; }; type ChecksCreateSuiteResponseAppPermissions = { @@ -19289,11 +21639,13 @@ declare namespace Octokit { svn_url: string; tags_url: string; teams_url: string; + temp_clone_token: string; template_repository: null; topics: Array; trees_url: string; updated_at: string; url: string; + visibility: string; watchers_count: number; }; type AppsListReposResponse = { @@ -19578,11 +21930,13 @@ declare namespace Octokit { svn_url: string; tags_url: string; teams_url: string; + temp_clone_token: string; template_repository: null; topics: Array; trees_url: string; updated_at: string; url: string; + visibility: string; watchers_count: number; }; type AppsListInstallationReposForAuthenticatedUserResponse = { @@ -20144,11 +22498,13 @@ declare namespace Octokit { svn_url: string; tags_url: string; teams_url: string; + temp_clone_token: string; template_repository: null; topics: Array; trees_url: string; updated_at: string; url: string; + visibility: string; watchers_count: number; }; type AppsCreateInstallationTokenResponsePermissions = { @@ -20530,11 +22886,13 @@ declare namespace Octokit { svn_url: string; tags_url: string; teams_url: string; + temp_clone_token: string; template_repository: null; topics: Array; trees_url: string; updated_at: string; url: string; + visibility: string; watchers_count: number; }; type ActivityListStargazersForRepoResponseItem = { @@ -20660,11 +23018,13 @@ declare namespace Octokit { svn_url: string; tags_url: string; teams_url: string; + temp_clone_token: string; template_repository: null; topics: Array; trees_url: string; updated_at: string; url: string; + visibility: string; watchers_count: number; }; type ActivityListReposStarredByUserResponseItemPermissions = { @@ -20765,11 +23125,13 @@ declare namespace Octokit { svn_url: string; tags_url: string; teams_url: string; + temp_clone_token: string; template_repository: null; topics: Array; trees_url: string; updated_at: string; url: string; + visibility: string; watchers_count: number; }; type ActivityListReposStarredByAuthenticatedUserResponseItemPermissions = { @@ -20870,11 +23232,13 @@ declare namespace Octokit { svn_url: string; tags_url: string; teams_url: string; + temp_clone_token: string; template_repository: null; topics: Array; trees_url: string; updated_at: string; url: string; + visibility: string; watchers_count: number; }; type ActivityListNotificationsForRepoResponseItemSubject = { @@ -21197,6 +23561,696 @@ declare namespace Octokit { subscribed: boolean; url: string; }; + type ActionsListWorkflowRunsResponseWorkflowRunsItemRepositoryOwner = { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; + id: number; + login: string; + node_id: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; + url: string; + }; + type ActionsListWorkflowRunsResponseWorkflowRunsItemRepository = { + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + description: string; + downloads_url: string; + events_url: string; + fork: boolean; + forks_url: string; + full_name: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + html_url: string; + id: number; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + name: string; + node_id: string; + notifications_url: string; + owner: ActionsListWorkflowRunsResponseWorkflowRunsItemRepositoryOwner; + private: boolean; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + url: string; + }; + type ActionsListWorkflowRunsResponseWorkflowRunsItemHeadRepositoryOwner = { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; + id: number; + login: string; + node_id: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; + url: string; + }; + type ActionsListWorkflowRunsResponseWorkflowRunsItemHeadRepository = { + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + description: null; + downloads_url: string; + events_url: string; + fork: boolean; + forks_url: string; + full_name: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + hooks_url: string; + html_url: string; + id: number; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + name: string; + node_id: string; + notifications_url: string; + owner: ActionsListWorkflowRunsResponseWorkflowRunsItemHeadRepositoryOwner; + private: boolean; + pulls_url: string; + releases_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + url: string; + }; + type ActionsListWorkflowRunsResponseWorkflowRunsItemHeadCommitCommitter = { + email: string; + name: string; + }; + type ActionsListWorkflowRunsResponseWorkflowRunsItemHeadCommitAuthor = { + email: string; + name: string; + }; + type ActionsListWorkflowRunsResponseWorkflowRunsItemHeadCommit = { + author: ActionsListWorkflowRunsResponseWorkflowRunsItemHeadCommitAuthor; + committer: ActionsListWorkflowRunsResponseWorkflowRunsItemHeadCommitCommitter; + id: string; + message: string; + timestamp: string; + tree_id: string; + }; + type ActionsListWorkflowRunsResponseWorkflowRunsItem = { + artifacts_url: string; + cancel_url: string; + check_suite_id: number; + conclusion: null; + created_at: string; + event: string; + head_branch: string; + head_commit: ActionsListWorkflowRunsResponseWorkflowRunsItemHeadCommit; + head_repository: ActionsListWorkflowRunsResponseWorkflowRunsItemHeadRepository; + head_sha: string; + html_url: string; + id: number; + jobs_url: string; + logs_url: string; + node_id: string; + pull_requests: Array; + repository: ActionsListWorkflowRunsResponseWorkflowRunsItemRepository; + rerun_url: string; + run_number: number; + status: string; + updated_at: string; + url: string; + workflow_url: string; + }; + type ActionsListWorkflowRunsResponse = { + total_count: number; + workflow_runs: Array; + }; + type ActionsListWorkflowRunArtifactsResponseArtifactsItem = { + archive_download_url: string; + created_at: string; + expired: string; + expires_at: string; + id: number; + name: string; + node_id: string; + size_in_bytes: number; + }; + type ActionsListWorkflowRunArtifactsResponse = { + artifacts: Array; + total_count: number; + }; + type ActionsListSelfHostedRunnersForRepoResponseItemItem = { + id: number; + name: string; + os: string; + status: string; + }; + type ActionsListSecretsForRepoResponseSecretsItem = { + created_at: string; + name: string; + updated_at: string; + }; + type ActionsListSecretsForRepoResponse = { + secrets: Array; + total_count: number; + }; + type ActionsListRepoWorkflowsResponseWorkflowsItem = { + badge_url: string; + created_at: string; + html_url: string; + id: number; + name: string; + node_id: string; + path: string; + state: string; + updated_at: string; + url: string; + }; + type ActionsListRepoWorkflowsResponse = { + total_count: number; + workflows: Array; + }; + type ActionsListRepoWorkflowRunsResponseWorkflowRunsItemRepositoryOwner = { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; + id: number; + login: string; + node_id: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; + url: string; + }; + type ActionsListRepoWorkflowRunsResponseWorkflowRunsItemRepository = { + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + description: string; + downloads_url: string; + events_url: string; + fork: boolean; + forks_url: string; + full_name: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + html_url: string; + id: number; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + name: string; + node_id: string; + notifications_url: string; + owner: ActionsListRepoWorkflowRunsResponseWorkflowRunsItemRepositoryOwner; + private: boolean; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + url: string; + }; + type ActionsListRepoWorkflowRunsResponseWorkflowRunsItemHeadRepositoryOwner = { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; + id: number; + login: string; + node_id: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; + url: string; + }; + type ActionsListRepoWorkflowRunsResponseWorkflowRunsItemHeadRepository = { + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + description: null; + downloads_url: string; + events_url: string; + fork: boolean; + forks_url: string; + full_name: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + hooks_url: string; + html_url: string; + id: number; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + name: string; + node_id: string; + notifications_url: string; + owner: ActionsListRepoWorkflowRunsResponseWorkflowRunsItemHeadRepositoryOwner; + private: boolean; + pulls_url: string; + releases_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + url: string; + }; + type ActionsListRepoWorkflowRunsResponseWorkflowRunsItemHeadCommitCommitter = { + email: string; + name: string; + }; + type ActionsListRepoWorkflowRunsResponseWorkflowRunsItemHeadCommitAuthor = { + email: string; + name: string; + }; + type ActionsListRepoWorkflowRunsResponseWorkflowRunsItemHeadCommit = { + author: ActionsListRepoWorkflowRunsResponseWorkflowRunsItemHeadCommitAuthor; + committer: ActionsListRepoWorkflowRunsResponseWorkflowRunsItemHeadCommitCommitter; + id: string; + message: string; + timestamp: string; + tree_id: string; + }; + type ActionsListRepoWorkflowRunsResponseWorkflowRunsItem = { + artifacts_url: string; + cancel_url: string; + check_suite_id: number; + conclusion: null; + created_at: string; + event: string; + head_branch: string; + head_commit: ActionsListRepoWorkflowRunsResponseWorkflowRunsItemHeadCommit; + head_repository: ActionsListRepoWorkflowRunsResponseWorkflowRunsItemHeadRepository; + head_sha: string; + html_url: string; + id: number; + jobs_url: string; + logs_url: string; + node_id: string; + pull_requests: Array; + repository: ActionsListRepoWorkflowRunsResponseWorkflowRunsItemRepository; + rerun_url: string; + run_number: number; + status: string; + updated_at: string; + url: string; + workflow_url: string; + }; + type ActionsListRepoWorkflowRunsResponse = { + total_count: number; + workflow_runs: Array; + }; + type ActionsListJobsForWorkflowRunResponseJobsItemStepsItem = { + completed_at: string; + conclusion: string; + name: string; + number: number; + started_at: string; + status: string; + }; + type ActionsListJobsForWorkflowRunResponseJobsItem = { + check_run_url: string; + completed_at: string; + conclusion: string; + head_sha: string; + html_url: string; + id: number; + name: string; + node_id: string; + run_id: number; + run_url: string; + started_at: string; + status: string; + steps: Array; + url: string; + }; + type ActionsListJobsForWorkflowRunResponse = { + jobs: Array; + total_count: number; + }; + type ActionsListDownloadsForSelfHostedRunnerApplicationResponseItem = { + architecture: string; + download_url: string; + filename: string; + os: string; + }; + type ActionsGetWorkflowRunResponseRepositoryOwner = { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; + id: number; + login: string; + node_id: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; + url: string; + }; + type ActionsGetWorkflowRunResponseRepository = { + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + description: string; + downloads_url: string; + events_url: string; + fork: boolean; + forks_url: string; + full_name: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + html_url: string; + id: number; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + name: string; + node_id: string; + notifications_url: string; + owner: ActionsGetWorkflowRunResponseRepositoryOwner; + private: boolean; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + url: string; + }; + type ActionsGetWorkflowRunResponseHeadRepositoryOwner = { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; + id: number; + login: string; + node_id: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; + url: string; + }; + type ActionsGetWorkflowRunResponseHeadRepository = { + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + description: null; + downloads_url: string; + events_url: string; + fork: boolean; + forks_url: string; + full_name: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + hooks_url: string; + html_url: string; + id: number; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + name: string; + node_id: string; + notifications_url: string; + owner: ActionsGetWorkflowRunResponseHeadRepositoryOwner; + private: boolean; + pulls_url: string; + releases_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + url: string; + }; + type ActionsGetWorkflowRunResponseHeadCommitCommitter = { + email: string; + name: string; + }; + type ActionsGetWorkflowRunResponseHeadCommitAuthor = { + email: string; + name: string; + }; + type ActionsGetWorkflowRunResponseHeadCommit = { + author: ActionsGetWorkflowRunResponseHeadCommitAuthor; + committer: ActionsGetWorkflowRunResponseHeadCommitCommitter; + id: string; + message: string; + timestamp: string; + tree_id: string; + }; + type ActionsGetWorkflowRunResponse = { + artifacts_url: string; + cancel_url: string; + check_suite_id: number; + conclusion: null; + created_at: string; + event: string; + head_branch: string; + head_commit: ActionsGetWorkflowRunResponseHeadCommit; + head_repository: ActionsGetWorkflowRunResponseHeadRepository; + head_sha: string; + html_url: string; + id: number; + jobs_url: string; + logs_url: string; + node_id: string; + pull_requests: Array; + repository: ActionsGetWorkflowRunResponseRepository; + rerun_url: string; + run_number: number; + status: string; + updated_at: string; + url: string; + workflow_url: string; + }; + type ActionsGetWorkflowJobResponseStepsItem = { + completed_at: string; + conclusion: string; + name: string; + number: number; + started_at: string; + status: string; + }; + type ActionsGetWorkflowJobResponse = { + check_run_url: string; + completed_at: string; + conclusion: string; + head_sha: string; + html_url: string; + id: number; + name: string; + node_id: string; + run_id: number; + run_url: string; + started_at: string; + status: string; + steps: Array; + url: string; + }; + type ActionsGetWorkflowResponse = { + badge_url: string; + created_at: string; + html_url: string; + id: number; + name: string; + node_id: string; + path: string; + state: string; + updated_at: string; + url: string; + }; + type ActionsGetSelfHostedRunnerResponse = { + id: number; + name: string; + os: string; + status: string; + }; + type ActionsGetSecretResponse = { + created_at: string; + name: string; + updated_at: string; + }; + type ActionsGetPublicKeyResponse = { key: string; key_id: string }; + type ActionsGetArtifactResponse = { + archive_download_url: string; + created_at: string; + expired: string; + expires_at: string; + id: number; + name: string; + node_id: string; + size_in_bytes: number; + }; + type ActionsCreateRemoveTokenResponse = { expires_at: string; token: string }; + type ActionsCreateRegistrationTokenResponse = { + expires_at: string; + token: string; + }; + type ActionsListDownloadsForSelfHostedRunnerApplicationResponse = Array< + ActionsListDownloadsForSelfHostedRunnerApplicationResponseItem + >; + type ActionsListSelfHostedRunnersForRepoResponse = Array< + Array + >; type ActivityListNotificationsResponse = Array< ActivityListNotificationsResponseItem >; @@ -21298,6 +24352,12 @@ declare namespace Octokit { MigrationsListForAuthenticatedUserResponseItem >; type MigrationsListForOrgResponse = Array; + type MigrationsListReposForOrgResponse = Array< + MigrationsListReposForOrgResponseItem + >; + type MigrationsListReposForUserResponse = Array< + MigrationsListReposForUserResponseItem + >; type OauthAuthorizationsListAuthorizationsResponse = Array< OauthAuthorizationsListAuthorizationsResponseItem >; @@ -21358,6 +24418,18 @@ declare namespace Octokit { type ReactionsListForTeamDiscussionCommentResponse = Array< ReactionsListForTeamDiscussionCommentResponseItem >; + type ReactionsListForTeamDiscussionCommentInOrgResponse = Array< + ReactionsListForTeamDiscussionCommentInOrgResponseItem + >; + type ReactionsListForTeamDiscussionCommentLegacyResponse = Array< + ReactionsListForTeamDiscussionCommentLegacyResponseItem + >; + type ReactionsListForTeamDiscussionInOrgResponse = Array< + ReactionsListForTeamDiscussionInOrgResponseItem + >; + type ReactionsListForTeamDiscussionLegacyResponse = Array< + ReactionsListForTeamDiscussionLegacyResponseItem + >; type ReposAddProtectedBranchAppRestrictionsResponse = Array< ReposAddProtectedBranchAppRestrictionsResponseItem >; @@ -21475,19 +24547,51 @@ declare namespace Octokit { >; type TeamsListResponse = Array; type TeamsListChildResponse = Array; + type TeamsListChildInOrgResponse = Array; + type TeamsListChildLegacyResponse = Array; type TeamsListDiscussionCommentsResponse = Array< TeamsListDiscussionCommentsResponseItem >; + type TeamsListDiscussionCommentsInOrgResponse = Array< + TeamsListDiscussionCommentsInOrgResponseItem + >; + type TeamsListDiscussionCommentsLegacyResponse = Array< + TeamsListDiscussionCommentsLegacyResponseItem + >; type TeamsListDiscussionsResponse = Array; + type TeamsListDiscussionsInOrgResponse = Array< + TeamsListDiscussionsInOrgResponseItem + >; + type TeamsListDiscussionsLegacyResponse = Array< + TeamsListDiscussionsLegacyResponseItem + >; type TeamsListForAuthenticatedUserResponse = Array< TeamsListForAuthenticatedUserResponseItem >; type TeamsListMembersResponse = Array; + type TeamsListMembersInOrgResponse = Array; + type TeamsListMembersLegacyResponse = Array< + TeamsListMembersLegacyResponseItem + >; type TeamsListPendingInvitationsResponse = Array< TeamsListPendingInvitationsResponseItem >; + type TeamsListPendingInvitationsInOrgResponse = Array< + TeamsListPendingInvitationsInOrgResponseItem + >; + type TeamsListPendingInvitationsLegacyResponse = Array< + TeamsListPendingInvitationsLegacyResponseItem + >; type TeamsListProjectsResponse = Array; + type TeamsListProjectsInOrgResponse = Array< + TeamsListProjectsInOrgResponseItem + >; + type TeamsListProjectsLegacyResponse = Array< + TeamsListProjectsLegacyResponseItem + >; type TeamsListReposResponse = Array; + type TeamsListReposInOrgResponse = Array; + type TeamsListReposLegacyResponse = Array; type UsersAddEmailsResponse = Array; type UsersListResponse = Array; type UsersListBlockedResponse = Array; @@ -21518,11 +24622,307 @@ declare namespace Octokit { >; // param types + export type ActionsCancelWorkflowRunParams = { + owner: string; + + repo: string; + + run_id: number; + }; + export type ActionsCreateOrUpdateSecretForRepoParams = { + /** + * Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get your public key](https://developer.github.com/v3/actions/secrets/#get-your-public-key) endpoint. + */ + encrypted_value?: string; + /** + * ID of the key you used to encrypt the secret. + */ + key_id?: string; + + name: string; + + owner: string; + + repo: string; + }; + export type ActionsCreateRegistrationTokenParams = { + owner: string; + + repo: string; + }; + export type ActionsCreateRemoveTokenParams = { + owner: string; + + repo: string; + }; + export type ActionsDeleteArtifactParams = { + artifact_id: number; + + owner: string; + + repo: string; + }; + export type ActionsDeleteSecretFromRepoParams = { + name: string; + + owner: string; + + repo: string; + }; + export type ActionsDownloadArtifactParams = { + archive_format: string; + + artifact_id: number; + + owner: string; + + repo: string; + }; + export type ActionsGetArtifactParams = { + artifact_id: number; + + owner: string; + + repo: string; + }; + export type ActionsGetPublicKeyParams = { + owner: string; + + repo: string; + }; + export type ActionsGetSecretParams = { + name: string; + + owner: string; + /** + * Page number of the results to fetch. + */ + page?: number; + /** + * Results per page (max 100) + */ + per_page?: number; + + repo: string; + }; + export type ActionsGetSelfHostedRunnerParams = { + owner: string; + + repo: string; + + runner_id: number; + }; + export type ActionsGetWorkflowParams = { + owner: string; + + repo: string; + + workflow_id: number; + }; + export type ActionsGetWorkflowJobParams = { + job_id: number; + + owner: string; + + repo: string; + }; + export type ActionsGetWorkflowRunParams = { + owner: string; + + repo: string; + + run_id: number; + }; + export type ActionsListDownloadsForSelfHostedRunnerApplicationParams = { + owner: string; + + repo: string; + }; + export type ActionsListJobsForWorkflowRunParams = { + owner: string; + /** + * Page number of the results to fetch. + */ + page?: number; + /** + * Results per page (max 100) + */ + per_page?: number; + + repo: string; + + run_id: number; + }; + export type ActionsListRepoWorkflowRunsParams = { + /** + * Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. + */ + actor?: string; + /** + * Returns workflow runs associated with a branch. Use the name of the branch of the `push`. + */ + branch?: string; + /** + * Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)" in the GitHub Help documentation. + */ + event?: string; + + owner: string; + /** + * Page number of the results to fetch. + */ + page?: number; + /** + * Results per page (max 100) + */ + per_page?: number; + + repo: string; + /** + * Returns workflow runs associated with the check run `status` or `conclusion` you specify. For example, a conclusion can be `success` or a status can be `completed`. For more information, see the `status` and `conclusion` options available in "[Create a check run](https://developer.github.com/v3/checks/runs/#create-a-check-run)." + */ + status?: "completed" | "status" | "conclusion"; + }; + export type ActionsListRepoWorkflowsParams = { + owner: string; + /** + * Page number of the results to fetch. + */ + page?: number; + /** + * Results per page (max 100) + */ + per_page?: number; + + repo: string; + }; + export type ActionsListSecretsForRepoParams = { + owner: string; + /** + * Page number of the results to fetch. + */ + page?: number; + /** + * Results per page (max 100) + */ + per_page?: number; + + repo: string; + }; + export type ActionsListSelfHostedRunnersForRepoParams = { + owner: string; + /** + * Page number of the results to fetch. + */ + page?: number; + /** + * Results per page (max 100) + */ + per_page?: number; + + repo: string; + }; + export type ActionsListWorkflowJobLogsParams = { + job_id: number; + + owner: string; + /** + * Page number of the results to fetch. + */ + page?: number; + /** + * Results per page (max 100) + */ + per_page?: number; + + repo: string; + }; + export type ActionsListWorkflowRunArtifactsParams = { + owner: string; + /** + * Page number of the results to fetch. + */ + page?: number; + /** + * Results per page (max 100) + */ + per_page?: number; + + repo: string; + + run_id: number; + }; + export type ActionsListWorkflowRunLogsParams = { + owner: string; + /** + * Page number of the results to fetch. + */ + page?: number; + /** + * Results per page (max 100) + */ + per_page?: number; + + repo: string; + + run_id: number; + }; + export type ActionsListWorkflowRunsParams = { + /** + * Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. + */ + actor?: string; + /** + * Returns workflow runs associated with a branch. Use the name of the branch of the `push`. + */ + branch?: string; + /** + * Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)" in the GitHub Help documentation. + */ + event?: string; + + owner: string; + /** + * Page number of the results to fetch. + */ + page?: number; + /** + * Results per page (max 100) + */ + per_page?: number; + + repo: string; + /** + * Returns workflow runs associated with the check run `status` or `conclusion` you specify. For example, a conclusion can be `success` or a status can be `completed`. For more information, see the `status` and `conclusion` options available in "[Create a check run](https://developer.github.com/v3/checks/runs/#create-a-check-run)." + */ + status?: "completed" | "status" | "conclusion"; + + workflow_id: number; + }; + export type ActionsReRunWorkflowParams = { + owner: string; + + repo: string; + + run_id: number; + }; + export type ActionsRemoveSelfHostedRunnerParams = { + owner: string; + + repo: string; + + runner_id: number; + }; export type ActivityCheckStarringRepoParams = { owner: string; repo: string; }; + export type ActivityCheckWatchingRepoLegacyParams = { + owner: string; + + repo: string; + }; export type ActivityDeleteRepoSubscriptionParams = { owner: string; @@ -21838,11 +25238,21 @@ declare namespace Octokit { repo: string; }; + export type ActivityStopWatchingRepoLegacyParams = { + owner: string; + + repo: string; + }; export type ActivityUnstarRepoParams = { owner: string; repo: string; }; + export type ActivityWatchRepoLegacyParams = { + owner: string; + + repo: string; + }; export type AppsAddRepoToInstallationParams = { installation_id: number; @@ -21850,25 +25260,9 @@ declare namespace Octokit { }; export type AppsCheckAccountIsAssociatedWithAnyParams = { account_id: number; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; }; export type AppsCheckAccountIsAssociatedWithAnyStubbedParams = { account_id: number; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; }; export type AppsCheckAuthorizationParams = { access_token: string; @@ -22977,14 +26371,6 @@ declare namespace Octokit { comment_id: number; owner: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; repo: string; }; @@ -23807,6 +27193,11 @@ declare namespace Octokit { org: string; }; + export type MigrationsDownloadArchiveForOrgParams = { + migration_id: number; + + org: string; + }; export type MigrationsGetArchiveForAuthenticatedUserParams = { migration_id: number; }; @@ -23863,6 +27254,30 @@ declare namespace Octokit { */ per_page?: number; }; + export type MigrationsListReposForOrgParams = { + migration_id: number; + + org: string; + /** + * Page number of the results to fetch. + */ + page?: number; + /** + * Results per page (max 100) + */ + per_page?: number; + }; + export type MigrationsListReposForUserParams = { + migration_id: number; + /** + * Page number of the results to fetch. + */ + page?: number; + /** + * Results per page (max 100) + */ + per_page?: number; + }; export type MigrationsMapCommitAuthorParams = { author_id: number; /** @@ -24253,9 +27668,9 @@ declare namespace Octokit { */ per_page?: number; /** - * The integer ID of the last Organization that you've seen. + * The integer ID of the last organization that you've seen. */ - since?: string; + since?: number; }; export type OrgsListBlockedUsersParams = { org: string; @@ -24426,6 +27841,88 @@ declare namespace Octokit { username: string; }; + export type OrgsUpdateParamsDeprecatedMembersAllowedRepositoryCreationType = { + /** + * Billing email address. This address is not publicized. + */ + billing_email?: string; + /** + * The company name. + */ + company?: string; + /** + * Default permission level members have for organization repositories: + * \* `read` - can pull, but not push to or administer this repository. + * \* `write` - can pull and push, but not administer this repository. + * \* `admin` - can pull, push, and administer this repository. + * \* `none` - no permissions granted by default. + */ + default_repository_permission?: "read" | "write" | "admin" | "none"; + /** + * The description of the company. + */ + description?: string; + /** + * The publicly visible email address. + */ + email?: string; + /** + * Toggles whether an organization can use organization projects. + */ + has_organization_projects?: boolean; + /** + * Toggles whether repositories that belong to the organization can use repository projects. + */ + has_repository_projects?: boolean; + /** + * The location. + */ + location?: string; + /** + * Specifies which types of repositories non-admin organization members can create. Can be one of: + * \* `all` - all organization members can create public and private repositories. + * \* `private` - members can create private repositories. This option is only available to repositories that are part of an organization on GitHub Enterprise Cloud. + * \* `none` - only admin members can create repositories. + * **Note:** This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See [this note](https://developer.github.com/v3/orgs/#members_can_create_repositories) for details. + * @deprecated "members_allowed_repository_creation_type" parameter has been deprecated and will be removed in future + */ + members_allowed_repository_creation_type?: string; + /** + * Toggles whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud. Can be one of: + * \* `true` - all organization members can create internal repositories. + * \* `false` - only organization owners can create internal repositories. + * Default: `true`. For more information, see "[Restricting repository creation in your organization](https://help.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. + */ + members_can_create_internal_repositories?: boolean; + /** + * Toggles whether organization members can create private repositories, which are visible to organization members with permission. Can be one of: + * \* `true` - all organization members can create private repositories. + * \* `false` - only organization owners can create private repositories. + * Default: `true`. For more information, see "[Restricting repository creation in your organization](https://help.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. + */ + members_can_create_private_repositories?: boolean; + /** + * Toggles whether organization members can create public repositories, which are visible to anyone. Can be one of: + * \* `true` - all organization members can create public repositories. + * \* `false` - only organization owners can create public repositories. + * Default: `true`. For more information, see "[Restricting repository creation in your organization](https://help.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. + */ + members_can_create_public_repositories?: boolean; + /** + * Toggles the ability of non-admin organization members to create repositories. Can be one of: + * \* `true` - all organization members can create repositories. + * \* `false` - only organization owners can create repositories. + * Default: `true` + * **Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details. **Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details. + */ + members_can_create_repositories?: boolean; + /** + * The shorthand name of the company. + */ + name?: string; + + org: string; + }; export type OrgsUpdateParams = { /** * Billing email address. This address is not publicized. @@ -24452,11 +27949,11 @@ declare namespace Octokit { */ email?: string; /** - * Toggles whether organization projects are enabled for the organization. + * Toggles whether an organization can use organization projects. */ has_organization_projects?: boolean; /** - * Toggles whether repository projects are enabled for repositories that belong to the organization. + * Toggles whether repositories that belong to the organization can use repository projects. */ has_repository_projects?: boolean; /** @@ -24464,19 +27961,32 @@ declare namespace Octokit { */ location?: string; /** - * Specifies which types of repositories non-admin organization members can create. Can be one of: - * \* `all` - all organization members can create public and private repositories. - * \* `private` - members can create private repositories. This option is only available to repositories that are part of an organization on [GitHub Business Cloud](https://github.com/pricing/business-cloud). - * \* `none` - only admin members can create repositories. - * **Note:** Using this parameter will override values set in `members_can_create_repositories`. See [this note](https://developer.github.com/v3/orgs/#members_can_create_repositories) for details. + * Toggles whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud. Can be one of: + * \* `true` - all organization members can create internal repositories. + * \* `false` - only organization owners can create internal repositories. + * Default: `true`. For more information, see "[Restricting repository creation in your organization](https://help.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. */ - members_allowed_repository_creation_type?: "all" | "private" | "none"; + members_can_create_internal_repositories?: boolean; + /** + * Toggles whether organization members can create private repositories, which are visible to organization members with permission. Can be one of: + * \* `true` - all organization members can create private repositories. + * \* `false` - only organization owners can create private repositories. + * Default: `true`. For more information, see "[Restricting repository creation in your organization](https://help.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. + */ + members_can_create_private_repositories?: boolean; + /** + * Toggles whether organization members can create public repositories, which are visible to anyone. Can be one of: + * \* `true` - all organization members can create public repositories. + * \* `false` - only organization owners can create public repositories. + * Default: `true`. For more information, see "[Restricting repository creation in your organization](https://help.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. + */ + members_can_create_public_repositories?: boolean; /** * Toggles the ability of non-admin organization members to create repositories. Can be one of: * \* `true` - all organization members can create repositories. - * \* `false` - only admin members can create repositories. + * \* `false` - only organization owners can create repositories. * Default: `true` - * **Note:** Another parameter can override the this parameter. See [this note](https://developer.github.com/v3/orgs/#members_can_create_repositories) for details. **Note:** Another parameter can override the this parameter. See [this note](https://developer.github.com/v3/orgs/#members_can_create_repositories) for details. + * **Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details. **Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details. */ members_can_create_repositories?: boolean; /** @@ -24594,15 +28104,6 @@ declare namespace Octokit { column_id: number; }; export type ProjectsGetParams = { - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - project_id: number; }; export type ProjectsGetCardParams = { @@ -25961,6 +29462,84 @@ declare namespace Octokit { team_id: number; }; + export type ReactionsCreateForTeamDiscussionCommentInOrgParams = { + comment_number: number; + /** + * The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the team discussion comment. + */ + content: + | "+1" + | "-1" + | "laugh" + | "confused" + | "heart" + | "hooray" + | "rocket" + | "eyes"; + + discussion_number: number; + + org: string; + + team_slug: string; + }; + export type ReactionsCreateForTeamDiscussionCommentLegacyParams = { + comment_number: number; + /** + * The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the team discussion comment. + */ + content: + | "+1" + | "-1" + | "laugh" + | "confused" + | "heart" + | "hooray" + | "rocket" + | "eyes"; + + discussion_number: number; + + team_id: number; + }; + export type ReactionsCreateForTeamDiscussionInOrgParams = { + /** + * The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the team discussion. + */ + content: + | "+1" + | "-1" + | "laugh" + | "confused" + | "heart" + | "hooray" + | "rocket" + | "eyes"; + + discussion_number: number; + + org: string; + + team_slug: string; + }; + export type ReactionsCreateForTeamDiscussionLegacyParams = { + /** + * The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the team discussion. + */ + content: + | "+1" + | "-1" + | "laugh" + | "confused" + | "heart" + | "hooray" + | "rocket" + | "eyes"; + + discussion_number: number; + + team_id: number; + }; export type ReactionsDeleteParams = { reaction_id: number; }; @@ -26156,6 +29735,116 @@ declare namespace Octokit { team_id: number; }; + export type ReactionsListForTeamDiscussionCommentInOrgParams = { + comment_number: number; + /** + * Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a team discussion comment. + */ + content?: + | "+1" + | "-1" + | "laugh" + | "confused" + | "heart" + | "hooray" + | "rocket" + | "eyes"; + + discussion_number: number; + + org: string; + /** + * Page number of the results to fetch. + */ + page?: number; + /** + * Results per page (max 100) + */ + per_page?: number; + + team_slug: string; + }; + export type ReactionsListForTeamDiscussionCommentLegacyParams = { + comment_number: number; + /** + * Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a team discussion comment. + */ + content?: + | "+1" + | "-1" + | "laugh" + | "confused" + | "heart" + | "hooray" + | "rocket" + | "eyes"; + + discussion_number: number; + /** + * Page number of the results to fetch. + */ + page?: number; + /** + * Results per page (max 100) + */ + per_page?: number; + + team_id: number; + }; + export type ReactionsListForTeamDiscussionInOrgParams = { + /** + * Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a team discussion. + */ + content?: + | "+1" + | "-1" + | "laugh" + | "confused" + | "heart" + | "hooray" + | "rocket" + | "eyes"; + + discussion_number: number; + + org: string; + /** + * Page number of the results to fetch. + */ + page?: number; + /** + * Results per page (max 100) + */ + per_page?: number; + + team_slug: string; + }; + export type ReactionsListForTeamDiscussionLegacyParams = { + /** + * Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a team discussion. + */ + content?: + | "+1" + | "-1" + | "laugh" + | "confused" + | "heart" + | "hooray" + | "rocket" + | "eyes"; + + discussion_number: number; + /** + * Page number of the results to fetch. + */ + page?: number; + /** + * Results per page (max 100) + */ + per_page?: number; + + team_id: number; + }; export type ReposAcceptInvitationParams = { invitation_id: number; }; @@ -26485,6 +30174,10 @@ declare namespace Octokit { * Pass `true` to create an initial commit with empty README. */ auto_init?: boolean; + /** + * Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion. + */ + delete_branch_on_merge?: boolean; /** * A short description of the repository. */ @@ -26529,6 +30222,11 @@ declare namespace Octokit { * The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization. */ team_id?: number; + /** + * Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud, `visibility` can also be `internal`. For more information, see "[Creating an internal repository](https://help.github.com/github/creating-cloning-and-archiving-repositories/creating-an-internal-repository)" in the GitHub Help documentation. + * The `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header. + */ + visibility?: "public" | "private" | "visibility" | "internal"; }; export type ReposCreateForkParams = { /** @@ -26579,6 +30277,10 @@ declare namespace Octokit { * Pass `true` to create an initial commit with empty README. */ auto_init?: boolean; + /** + * Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion. + */ + delete_branch_on_merge?: boolean; /** * A short description of the repository. */ @@ -26625,6 +30327,11 @@ declare namespace Octokit { * The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization. */ team_id?: number; + /** + * Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud, `visibility` can also be `internal`. For more information, see "[Creating an internal repository](https://help.github.com/github/creating-cloning-and-archiving-repositories/creating-an-internal-repository)" in the GitHub Help documentation. + * The `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header. + */ + visibility?: "public" | "private" | "visibility" | "internal"; }; export type ReposCreateOrUpdateFileParams = { /** @@ -27427,9 +31134,16 @@ declare namespace Octokit { */ sort?: "created" | "updated" | "pushed" | "full_name"; /** - * Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`. + * Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud, `type` can also be `internal`. */ - type?: "all" | "public" | "private" | "forks" | "sources" | "member"; + type?: + | "all" + | "public" + | "private" + | "forks" + | "sources" + | "member" + | "internal"; }; export type ReposListForUserParams = { /** @@ -27557,9 +31271,9 @@ declare namespace Octokit { */ per_page?: number; /** - * The integer ID of the last Repository that you've seen. + * The integer ID of the last repository that you've seen. */ - since?: string; + since?: number; }; export type ReposListPullRequestsAssociatedWithCommitParams = { commit_sha: string; @@ -27864,6 +31578,10 @@ declare namespace Octokit { * Updates the default branch for this repository. */ default_branch?: string; + /** + * Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion. + */ + delete_branch_on_merge?: boolean; /** * A short description of the repository. */ @@ -27901,8 +31619,21 @@ declare namespace Octokit { private?: boolean; repo: string; + /** + * Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud, `visibility` can also be `internal`. The `visibility` parameter overrides the `private` parameter when you use both along with the `nebula-preview` preview header. + */ + visibility?: "public" | "private" | "visibility" | "internal"; }; export type ReposUpdateBranchProtectionParams = { + /** + * Allows deletion of the protected branch by anyone with write access to the repository. Set to `false` to prevent deletion of the protected branch. Default: `false`. For more information, see "[Enabling force pushes to a protected branch](https://help.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" in the GitHub Help documentation. + */ + allow_deletions?: boolean; + /** + * Permits force pushes to the protected branch by anyone with write access to the repository. Set to `true` to allow force pushes. Set to `false` or `null` to block force pushes. Default: `false`. For more information, see "[Enabling force pushes to a protected branch](https://help.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" in the GitHub Help documentation." + */ + allow_force_pushes?: boolean | null; + branch: string; /** * Enforce all configured restrictions for administrators. Set to `true` to enforce required status checks for repository administrators. Set to `null` to disable. @@ -27912,6 +31643,10 @@ declare namespace Octokit { owner: string; repo: string; + /** + * Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to `true` to enforce a linear commit history. Set to `false` to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: `false`. For more information, see "[Requiring a linear commit history](https://help.github.com/github/administering-a-repository/requiring-a-linear-commit-history)" in the GitHub Help documentation. + */ + required_linear_history?: boolean; /** * Require at least one approving review on a pull request, before merging. Set to `null` to disable. */ @@ -27921,7 +31656,7 @@ declare namespace Octokit { */ required_status_checks: ReposUpdateBranchProtectionParamsRequiredStatusChecks | null; /** - * Restrict who can push to this branch. User, app, and team `restrictions` are only available for organization-owned repositories. Set to `null` to disable. + * Restrict who can push to the protected branch. User, app, and team `restrictions` are only available for organization-owned repositories. Set to `null` to disable. */ restrictions: ReposUpdateBranchProtectionParamsRestrictions | null; }; @@ -28107,7 +31842,10 @@ declare namespace Octokit { repo: string; }; - export type ReposUploadReleaseAssetParams = { + export type ReposUploadReleaseAssetParamsDeprecatedFile = { + /** + * @deprecated "file" parameter renamed to "data" + */ file: string | object; headers: ReposUploadReleaseAssetParamsHeaders; @@ -28124,6 +31862,23 @@ declare namespace Octokit { */ url: string; }; + export type ReposUploadReleaseAssetParams = { + data: string | object; + + headers: ReposUploadReleaseAssetParamsHeaders; + /** + * An alternate short description of the asset. Used in place of the filename. This should be set in a URI query parameter. + */ + label?: string; + /** + * The file name of the asset. This should be set in a URI query parameter. + */ + name: string; + /** + * The `upload_url` key returned from creating or getting a release + */ + url: string; + }; export type SearchCodeParams = { /** * Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. @@ -28168,6 +31923,12 @@ declare namespace Octokit { */ sort?: "author-date" | "committer-date"; }; + export type SearchEmailLegacyParams = { + /** + * The email address. + */ + email: string; + }; export type SearchIssuesParams = { /** * Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. @@ -28234,6 +31995,20 @@ declare namespace Octokit { | "created" | "updated"; }; + export type SearchIssuesLegacyParams = { + /** + * The search term. + */ + keyword: string; + + owner: string; + + repository: string; + /** + * Indicates the state of the issues to return. Can be either `open` or `closed`. + */ + state: "open" | "closed"; + }; export type SearchLabelsParams = { /** * Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. @@ -28274,6 +32049,28 @@ declare namespace Octokit { */ sort?: "stars" | "forks" | "help-wanted-issues" | "updated"; }; + export type SearchReposLegacyParams = { + /** + * The search term. + */ + keyword: string; + /** + * Filter results by language. + */ + language?: string; + /** + * The sort field. if `sort` param is provided. Can be either `asc` or `desc`. + */ + order?: "asc" | "desc"; + /** + * The sort field. One of `stars`, `forks`, or `updated`. Default: results are sorted by best match. + */ + sort?: "stars" | "forks" | "updated"; + /** + * The page number to fetch. + */ + start_page?: string; + }; export type SearchTopicsParams = { /** * The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). @@ -28302,11 +32099,34 @@ declare namespace Octokit { */ sort?: "followers" | "repositories" | "joined"; }; + export type SearchUsersLegacyParams = { + /** + * The search term. + */ + keyword: string; + /** + * The sort field. if `sort` param is provided. Can be either `asc` or `desc`. + */ + order?: "asc" | "desc"; + /** + * The sort field. One of `stars`, `forks`, or `updated`. Default: results are sorted by best match. + */ + sort?: "stars" | "forks" | "updated"; + /** + * The page number to fetch. + */ + start_page?: string; + }; export type TeamsAddMemberParams = { team_id: number; username: string; }; + export type TeamsAddMemberLegacyParams = { + team_id: number; + + username: string; + }; export type TeamsAddOrUpdateMembershipParams = { /** * The role that this user should have in the team. Can be one of: @@ -28319,6 +32139,31 @@ declare namespace Octokit { username: string; }; + export type TeamsAddOrUpdateMembershipInOrgParams = { + org: string; + /** + * The role that this user should have in the team. Can be one of: + * \* `member` - a normal member of the team. + * \* `maintainer` - a team maintainer. Able to add/remove other team members, promote other team members to team maintainer, and edit the team's name and description. + */ + role?: "member" | "maintainer"; + + team_slug: string; + + username: string; + }; + export type TeamsAddOrUpdateMembershipLegacyParams = { + /** + * The role that this user should have in the team. Can be one of: + * \* `member` - a normal member of the team. + * \* `maintainer` - a team maintainer. Able to add/remove other team members, promote other team members to team maintainer, and edit the team's name and description. + */ + role?: "member" | "maintainer"; + + team_id: number; + + username: string; + }; export type TeamsAddOrUpdateProjectParams = { /** * The permission to grant to the team for this project. Can be one of: @@ -28326,7 +32171,35 @@ declare namespace Octokit { * \* `write` - team members can read and write, but not administer this project. * \* `admin` - team members can read, write and administer this project. * Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://developer.github.com/v3/#http-verbs)." - * **Note**: If you pass the `hellcat-preview` media type, you can promote—but not demote—a `permission` attribute inherited from a parent team. + */ + permission?: "read" | "write" | "admin"; + + project_id: number; + + team_id: number; + }; + export type TeamsAddOrUpdateProjectInOrgParams = { + org: string; + /** + * The permission to grant to the team for this project. Can be one of: + * \* `read` - team members can read, but not write to or administer this project. + * \* `write` - team members can read and write, but not administer this project. + * \* `admin` - team members can read, write and administer this project. + * Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://developer.github.com/v3/#http-verbs)." + */ + permission?: "read" | "write" | "admin"; + + project_id: number; + + team_slug: string; + }; + export type TeamsAddOrUpdateProjectLegacyParams = { + /** + * The permission to grant to the team for this project. Can be one of: + * \* `read` - team members can read, but not write to or administer this project. + * \* `write` - team members can read and write, but not administer this project. + * \* `admin` - team members can read, write and administer this project. + * Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://developer.github.com/v3/#http-verbs)." */ permission?: "read" | "write" | "admin"; @@ -28343,7 +32216,40 @@ declare namespace Octokit { * \* `admin` - team members can pull, push and administer this repository. * * If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository. - * **Note**: If you pass the `hellcat-preview` media type, you can promote—but not demote—a `permission` attribute inherited through a parent team. + */ + permission?: "pull" | "push" | "admin"; + + repo: string; + + team_id: number; + }; + export type TeamsAddOrUpdateRepoInOrgParams = { + org: string; + + owner: string; + /** + * The permission to grant the team on this repository. Can be one of: + * \* `pull` - team members can pull, but not push to or administer this repository. + * \* `push` - team members can pull and push, but not administer this repository. + * \* `admin` - team members can pull, push and administer this repository. + * + * If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository. + */ + permission?: "pull" | "push" | "admin"; + + repo: string; + + team_slug: string; + }; + export type TeamsAddOrUpdateRepoLegacyParams = { + owner: string; + /** + * The permission to grant the team on this repository. Can be one of: + * \* `pull` - team members can pull, but not push to or administer this repository. + * \* `push` - team members can pull and push, but not administer this repository. + * \* `admin` - team members can pull, push and administer this repository. + * + * If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository. */ permission?: "pull" | "push" | "admin"; @@ -28358,13 +32264,29 @@ declare namespace Octokit { team_id: number; }; + export type TeamsCheckManagesRepoInOrgParams = { + org: string; + + owner: string; + + repo: string; + + team_slug: string; + }; + export type TeamsCheckManagesRepoLegacyParams = { + owner: string; + + repo: string; + + team_id: number; + }; export type TeamsCreateParamsDeprecatedPermission = { /** * The description of the team. */ description?: string; /** - * The logins of organization members to add as maintainers of the team. + * List GitHub IDs for organization members who will become team maintainers. */ maintainers?: string[]; /** @@ -28374,7 +32296,7 @@ declare namespace Octokit { org: string; /** - * The ID of a team to set as the parent team. **Note**: You must pass the `hellcat-preview` media type to use this parameter. + * The ID of a team to set as the parent team. */ parent_team_id?: number; /** @@ -28394,7 +32316,6 @@ declare namespace Octokit { * **For a parent or child team:** * \* `closed` - visible to all members of this organization. * Default for child team: `closed` - * **Note**: You must pass the `hellcat-preview` media type to set privacy default to `closed` for child teams. */ privacy?: "secret" | "closed"; /** @@ -28408,7 +32329,7 @@ declare namespace Octokit { */ description?: string; /** - * The logins of organization members to add as maintainers of the team. + * List GitHub IDs for organization members who will become team maintainers. */ maintainers?: string[]; /** @@ -28418,7 +32339,7 @@ declare namespace Octokit { org: string; /** - * The ID of a team to set as the parent team. **Note**: You must pass the `hellcat-preview` media type to use this parameter. + * The ID of a team to set as the parent team. */ parent_team_id?: number; /** @@ -28430,7 +32351,6 @@ declare namespace Octokit { * **For a parent or child team:** * \* `closed` - visible to all members of this organization. * Default for child team: `closed` - * **Note**: You must pass the `hellcat-preview` media type to set privacy default to `closed` for child teams. */ privacy?: "secret" | "closed"; /** @@ -28464,6 +32384,62 @@ declare namespace Octokit { team_id: number; }; + export type TeamsCreateDiscussionCommentInOrgParams = { + /** + * The discussion comment's body text. + */ + body: string; + + discussion_number: number; + + org: string; + + team_slug: string; + }; + export type TeamsCreateDiscussionCommentLegacyParams = { + /** + * The discussion comment's body text. + */ + body: string; + + discussion_number: number; + + team_id: number; + }; + export type TeamsCreateDiscussionInOrgParams = { + /** + * The discussion post's body text. + */ + body: string; + + org: string; + /** + * Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post. + */ + private?: boolean; + + team_slug: string; + /** + * The discussion post's title. + */ + title: string; + }; + export type TeamsCreateDiscussionLegacyParams = { + /** + * The discussion post's body text. + */ + body: string; + /** + * Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post. + */ + private?: boolean; + + team_id: number; + /** + * The discussion post's title. + */ + title: string; + }; export type TeamsDeleteParams = { team_id: number; }; @@ -28479,6 +32455,42 @@ declare namespace Octokit { team_id: number; }; + export type TeamsDeleteDiscussionCommentInOrgParams = { + comment_number: number; + + discussion_number: number; + + org: string; + + team_slug: string; + }; + export type TeamsDeleteDiscussionCommentLegacyParams = { + comment_number: number; + + discussion_number: number; + + team_id: number; + }; + export type TeamsDeleteDiscussionInOrgParams = { + discussion_number: number; + + org: string; + + team_slug: string; + }; + export type TeamsDeleteDiscussionLegacyParams = { + discussion_number: number; + + team_id: number; + }; + export type TeamsDeleteInOrgParams = { + org: string; + + team_slug: string; + }; + export type TeamsDeleteLegacyParams = { + team_id: number; + }; export type TeamsGetParams = { team_id: number; }; @@ -28499,16 +32511,64 @@ declare namespace Octokit { team_id: number; }; + export type TeamsGetDiscussionCommentInOrgParams = { + comment_number: number; + + discussion_number: number; + + org: string; + + team_slug: string; + }; + export type TeamsGetDiscussionCommentLegacyParams = { + comment_number: number; + + discussion_number: number; + + team_id: number; + }; + export type TeamsGetDiscussionInOrgParams = { + discussion_number: number; + + org: string; + + team_slug: string; + }; + export type TeamsGetDiscussionLegacyParams = { + discussion_number: number; + + team_id: number; + }; + export type TeamsGetLegacyParams = { + team_id: number; + }; export type TeamsGetMemberParams = { team_id: number; username: string; }; + export type TeamsGetMemberLegacyParams = { + team_id: number; + + username: string; + }; export type TeamsGetMembershipParams = { team_id: number; username: string; }; + export type TeamsGetMembershipInOrgParams = { + org: string; + + team_slug: string; + + username: string; + }; + export type TeamsGetMembershipLegacyParams = { + team_id: number; + + username: string; + }; export type TeamsListParams = { org: string; /** @@ -28532,6 +32592,31 @@ declare namespace Octokit { team_id: number; }; + export type TeamsListChildInOrgParams = { + org: string; + /** + * Page number of the results to fetch. + */ + page?: number; + /** + * Results per page (max 100) + */ + per_page?: number; + + team_slug: string; + }; + export type TeamsListChildLegacyParams = { + /** + * Page number of the results to fetch. + */ + page?: number; + /** + * Results per page (max 100) + */ + per_page?: number; + + team_id: number; + }; export type TeamsListDiscussionCommentsParams = { /** * Sorts the discussion comments by the date they were created. To return the oldest comments first, set to `asc`. Can be one of `asc` or `desc`. @@ -28550,6 +32635,44 @@ declare namespace Octokit { team_id: number; }; + export type TeamsListDiscussionCommentsInOrgParams = { + /** + * Sorts the discussion comments by the date they were created. To return the oldest comments first, set to `asc`. Can be one of `asc` or `desc`. + */ + direction?: "asc" | "desc"; + + discussion_number: number; + + org: string; + /** + * Page number of the results to fetch. + */ + page?: number; + /** + * Results per page (max 100) + */ + per_page?: number; + + team_slug: string; + }; + export type TeamsListDiscussionCommentsLegacyParams = { + /** + * Sorts the discussion comments by the date they were created. To return the oldest comments first, set to `asc`. Can be one of `asc` or `desc`. + */ + direction?: "asc" | "desc"; + + discussion_number: number; + /** + * Page number of the results to fetch. + */ + page?: number; + /** + * Results per page (max 100) + */ + per_page?: number; + + team_id: number; + }; export type TeamsListDiscussionsParams = { /** * Sorts the discussion comments by the date they were created. To return the oldest comments first, set to `asc`. Can be one of `asc` or `desc`. @@ -28566,6 +32689,40 @@ declare namespace Octokit { team_id: number; }; + export type TeamsListDiscussionsInOrgParams = { + /** + * Sorts the discussion comments by the date they were created. To return the oldest comments first, set to `asc`. Can be one of `asc` or `desc`. + */ + direction?: "asc" | "desc"; + + org: string; + /** + * Page number of the results to fetch. + */ + page?: number; + /** + * Results per page (max 100) + */ + per_page?: number; + + team_slug: string; + }; + export type TeamsListDiscussionsLegacyParams = { + /** + * Sorts the discussion comments by the date they were created. To return the oldest comments first, set to `asc`. Can be one of `asc` or `desc`. + */ + direction?: "asc" | "desc"; + /** + * Page number of the results to fetch. + */ + page?: number; + /** + * Results per page (max 100) + */ + per_page?: number; + + team_id: number; + }; export type TeamsListForAuthenticatedUserParams = { /** * Page number of the results to fetch. @@ -28595,6 +32752,45 @@ declare namespace Octokit { team_id: number; }; + export type TeamsListMembersInOrgParams = { + org: string; + /** + * Page number of the results to fetch. + */ + page?: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Filters members returned by their role in the team. Can be one of: + * \* `member` - normal members of the team. + * \* `maintainer` - team maintainers. + * \* `all` - all members of the team. + */ + role?: "member" | "maintainer" | "all"; + + team_slug: string; + }; + export type TeamsListMembersLegacyParams = { + /** + * Page number of the results to fetch. + */ + page?: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Filters members returned by their role in the team. Can be one of: + * \* `member` - normal members of the team. + * \* `maintainer` - team maintainers. + * \* `all` - all members of the team. + */ + role?: "member" | "maintainer" | "all"; + + team_id: number; + }; export type TeamsListPendingInvitationsParams = { /** * Page number of the results to fetch. @@ -28607,6 +32803,31 @@ declare namespace Octokit { team_id: number; }; + export type TeamsListPendingInvitationsInOrgParams = { + org: string; + /** + * Page number of the results to fetch. + */ + page?: number; + /** + * Results per page (max 100) + */ + per_page?: number; + + team_slug: string; + }; + export type TeamsListPendingInvitationsLegacyParams = { + /** + * Page number of the results to fetch. + */ + page?: number; + /** + * Results per page (max 100) + */ + per_page?: number; + + team_id: number; + }; export type TeamsListProjectsParams = { /** * Page number of the results to fetch. @@ -28619,6 +32840,31 @@ declare namespace Octokit { team_id: number; }; + export type TeamsListProjectsInOrgParams = { + org: string; + /** + * Page number of the results to fetch. + */ + page?: number; + /** + * Results per page (max 100) + */ + per_page?: number; + + team_slug: string; + }; + export type TeamsListProjectsLegacyParams = { + /** + * Page number of the results to fetch. + */ + page?: number; + /** + * Results per page (max 100) + */ + per_page?: number; + + team_id: number; + }; export type TeamsListReposParams = { /** * Page number of the results to fetch. @@ -28631,21 +32877,75 @@ declare namespace Octokit { team_id: number; }; + export type TeamsListReposInOrgParams = { + org: string; + /** + * Page number of the results to fetch. + */ + page?: number; + /** + * Results per page (max 100) + */ + per_page?: number; + + team_slug: string; + }; + export type TeamsListReposLegacyParams = { + /** + * Page number of the results to fetch. + */ + page?: number; + /** + * Results per page (max 100) + */ + per_page?: number; + + team_id: number; + }; export type TeamsRemoveMemberParams = { team_id: number; username: string; }; + export type TeamsRemoveMemberLegacyParams = { + team_id: number; + + username: string; + }; export type TeamsRemoveMembershipParams = { team_id: number; username: string; }; + export type TeamsRemoveMembershipInOrgParams = { + org: string; + + team_slug: string; + + username: string; + }; + export type TeamsRemoveMembershipLegacyParams = { + team_id: number; + + username: string; + }; export type TeamsRemoveProjectParams = { project_id: number; team_id: number; }; + export type TeamsRemoveProjectInOrgParams = { + org: string; + + project_id: number; + + team_slug: string; + }; + export type TeamsRemoveProjectLegacyParams = { + project_id: number; + + team_id: number; + }; export type TeamsRemoveRepoParams = { owner: string; @@ -28653,11 +32953,39 @@ declare namespace Octokit { team_id: number; }; + export type TeamsRemoveRepoInOrgParams = { + org: string; + + owner: string; + + repo: string; + + team_slug: string; + }; + export type TeamsRemoveRepoLegacyParams = { + owner: string; + + repo: string; + + team_id: number; + }; export type TeamsReviewProjectParams = { project_id: number; team_id: number; }; + export type TeamsReviewProjectInOrgParams = { + org: string; + + project_id: number; + + team_slug: string; + }; + export type TeamsReviewProjectLegacyParams = { + project_id: number; + + team_id: number; + }; export type TeamsUpdateParamsDeprecatedPermission = { /** * The description of the team. @@ -28668,7 +32996,7 @@ declare namespace Octokit { */ name: string; /** - * The ID of a team to set as the parent team. **Note**: You must pass the `hellcat-preview` media type to use this parameter. + * The ID of a team to set as the parent team. */ parent_team_id?: number; /** @@ -28701,7 +33029,7 @@ declare namespace Octokit { */ name: string; /** - * The ID of a team to set as the parent team. **Note**: You must pass the `hellcat-preview` media type to use this parameter. + * The ID of a team to set as the parent team. */ parent_team_id?: number; /** @@ -28742,6 +33070,182 @@ declare namespace Octokit { team_id: number; }; + export type TeamsUpdateDiscussionCommentInOrgParams = { + /** + * The discussion comment's body text. + */ + body: string; + + comment_number: number; + + discussion_number: number; + + org: string; + + team_slug: string; + }; + export type TeamsUpdateDiscussionCommentLegacyParams = { + /** + * The discussion comment's body text. + */ + body: string; + + comment_number: number; + + discussion_number: number; + + team_id: number; + }; + export type TeamsUpdateDiscussionInOrgParams = { + /** + * The discussion post's body text. + */ + body?: string; + + discussion_number: number; + + org: string; + + team_slug: string; + /** + * The discussion post's title. + */ + title?: string; + }; + export type TeamsUpdateDiscussionLegacyParams = { + /** + * The discussion post's body text. + */ + body?: string; + + discussion_number: number; + + team_id: number; + /** + * The discussion post's title. + */ + title?: string; + }; + export type TeamsUpdateInOrgParamsDeprecatedPermission = { + /** + * The description of the team. + */ + description?: string; + /** + * The name of the team. + */ + name: string; + + org: string; + /** + * The ID of a team to set as the parent team. + */ + parent_team_id?: number; + /** + * **Deprecated**. The permission that new repositories will be added to the team with when none is specified. Can be one of: + * \* `pull` - team members can pull, but not push to or administer newly-added repositories. + * \* `push` - team members can pull and push, but not administer newly-added repositories. + * \* `admin` - team members can pull, push and administer newly-added repositories. + * @deprecated "permission" parameter has been deprecated and will be removed in future + */ + permission?: string; + /** + * The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. When a team is nested, the `privacy` for parent teams cannot be `secret`. The options are: + * **For a non-nested team:** + * \* `secret` - only visible to organization owners and members of this team. + * \* `closed` - visible to all members of this organization. + * **For a parent or child team:** + * \* `closed` - visible to all members of this organization. + */ + privacy?: "secret" | "closed"; + + team_slug: string; + }; + export type TeamsUpdateInOrgParams = { + /** + * The description of the team. + */ + description?: string; + /** + * The name of the team. + */ + name: string; + + org: string; + /** + * The ID of a team to set as the parent team. + */ + parent_team_id?: number; + /** + * The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. When a team is nested, the `privacy` for parent teams cannot be `secret`. The options are: + * **For a non-nested team:** + * \* `secret` - only visible to organization owners and members of this team. + * \* `closed` - visible to all members of this organization. + * **For a parent or child team:** + * \* `closed` - visible to all members of this organization. + */ + privacy?: "secret" | "closed"; + + team_slug: string; + }; + export type TeamsUpdateLegacyParamsDeprecatedPermission = { + /** + * The description of the team. + */ + description?: string; + /** + * The name of the team. + */ + name: string; + /** + * The ID of a team to set as the parent team. + */ + parent_team_id?: number; + /** + * **Deprecated**. The permission that new repositories will be added to the team with when none is specified. Can be one of: + * \* `pull` - team members can pull, but not push to or administer newly-added repositories. + * \* `push` - team members can pull and push, but not administer newly-added repositories. + * \* `admin` - team members can pull, push and administer newly-added repositories. + * @deprecated "permission" parameter has been deprecated and will be removed in future + */ + permission?: string; + /** + * The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. The options are: + * **For a non-nested team:** + * \* `secret` - only visible to organization owners and members of this team. + * \* `closed` - visible to all members of this organization. + * **For a parent or child team:** + * \* `closed` - visible to all members of this organization. + */ + privacy?: "secret" | "closed"; + + team_id: number; + }; + export type TeamsUpdateLegacyParams = { + /** + * The description of the team. + */ + description?: string; + /** + * The name of the team. + */ + name: string; + /** + * The ID of a team to set as the parent team. + */ + parent_team_id?: number; + /** + * The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. The options are: + * **For a non-nested team:** + * \* `secret` - only visible to organization owners and members of this team. + * \* `closed` - visible to all members of this organization. + * **For a parent or child team:** + * \* `closed` - visible to all members of this organization. + */ + privacy?: "secret" | "closed"; + + team_id: number; + }; export type UsersAddEmailsParams = { /** * Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key. @@ -29169,7 +33673,7 @@ declare namespace Octokit { }; } -declare class Octokit { +export class Octokit { constructor(options?: Octokit.Options); authenticate(auth: Octokit.AuthBasic): void; authenticate(auth: Octokit.AuthOAuthToken): void; @@ -29216,6 +33720,321 @@ declare class Octokit { log: Octokit.Log; + actions: { + /** + * Cancels a workflow run using its `id`. Anyone with write access to the repository can use this endpoint. GitHub Apps must have the `actions` permission to use this endpoint. + */ + cancelWorkflowRun: { + ( + params?: Octokit.RequestOptions & Octokit.ActionsCancelWorkflowRunParams + ): Promise; + + endpoint: Octokit.Endpoint; + }; + /** + * Creates or updates a secret with an encrypted value. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). Anyone with write access to the repository can use this endpoint. GitHub Apps must have the `secrets` permission to use this endpoint. + * + * Encrypt your secret using the [tweetsodium](https://github.com/mastahyeti/tweetsodium) library. + * + * + * + * Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/stable/public/#nacl-public-sealedbox) with Python 3. + * + * + * + * Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package. + * + * + * + * Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem. + */ + createOrUpdateSecretForRepo: { + ( + params?: Octokit.RequestOptions & + Octokit.ActionsCreateOrUpdateSecretForRepoParams + ): Promise; + + endpoint: Octokit.Endpoint; + }; + /** + * Returns a token that you can pass to the `config` script. The token expires after one hour. Anyone with admin access to the repository can use this endpoint. GitHub Apps must have the `administration` permission to use this endpoint. + * + * Configure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint. + */ + createRegistrationToken: { + ( + params?: Octokit.RequestOptions & + Octokit.ActionsCreateRegistrationTokenParams + ): Promise< + Octokit.Response + >; + + endpoint: Octokit.Endpoint; + }; + /** + * Returns a token that you can pass to remove a self-hosted runner from a repository. The token expires after one hour. Anyone with admin access to the repository can use this endpoint. GitHub Apps must have the `administration` permission to use this endpoint. + * + * Remove your self-hosted runner from a repository, replacing TOKEN with the remove token provided by this endpoint. + */ + createRemoveToken: { + ( + params?: Octokit.RequestOptions & Octokit.ActionsCreateRemoveTokenParams + ): Promise>; + + endpoint: Octokit.Endpoint; + }; + /** + * Deletes an artifact for a workflow run. Anyone with write access to the repository can use this endpoint. GitHub Apps must have the `actions` permission to use this endpoint. + */ + deleteArtifact: { + ( + params?: Octokit.RequestOptions & Octokit.ActionsDeleteArtifactParams + ): Promise; + + endpoint: Octokit.Endpoint; + }; + /** + * Deletes a secret in a repository using the secret name. Anyone with write access to the repository can use this endpoint. GitHub Apps must have the `secrets` permission to use this endpoint. + */ + deleteSecretFromRepo: { + ( + params?: Octokit.RequestOptions & + Octokit.ActionsDeleteSecretFromRepoParams + ): Promise; + + endpoint: Octokit.Endpoint; + }; + /** + * Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for `Location:` in the response header to find the URL for the download. The `:archive_format` must be `zip`. Anyone with read access to the repository can use this endpoint. GitHub Apps must have the `actions` permission to use this endpoint. + * + * Call this endpoint using the `-v` flag, which enables verbose output and allows you to see the download URL in the header. To download the file into the current working directory, specify the filename using the `-o` flag. + */ + downloadArtifact: { + ( + params?: Octokit.RequestOptions & Octokit.ActionsDownloadArtifactParams + ): Promise; + + endpoint: Octokit.Endpoint; + }; + /** + * Gets a specific artifact for a workflow run. Anyone with read access to the repository can use this endpoint. GitHub Apps must have the `actions` permission to use this endpoint. + */ + getArtifact: { + ( + params?: Octokit.RequestOptions & Octokit.ActionsGetArtifactParams + ): Promise>; + + endpoint: Octokit.Endpoint; + }; + /** + * Gets your public key, which you must store. You need your public key to use other secrets endpoints. Use the returned `key` to encrypt your secrets. Anyone with read access to the repository can use this endpoint. GitHub Apps must have the `secrets` permission to use this endpoint. + */ + getPublicKey: { + ( + params?: Octokit.RequestOptions & Octokit.ActionsGetPublicKeyParams + ): Promise>; + + endpoint: Octokit.Endpoint; + }; + /** + * Gets a single secret without revealing its encrypted value. Anyone with write access to the repository can use this endpoint. GitHub Apps must have the `secrets` permission to use this endpoint. + */ + getSecret: { + ( + params?: Octokit.RequestOptions & Octokit.ActionsGetSecretParams + ): Promise>; + + endpoint: Octokit.Endpoint; + }; + /** + * Gets a specific self-hosted runner. Anyone with admin access to the repository can use this endpoint. GitHub Apps must have the `administration` permission to use this endpoint. + */ + getSelfHostedRunner: { + ( + params?: Octokit.RequestOptions & + Octokit.ActionsGetSelfHostedRunnerParams + ): Promise>; + + endpoint: Octokit.Endpoint; + }; + /** + * Gets a specific workflow. You can also replace `:workflow_id` with `:workflow_file_name`. For example, you could use `main.yml`. Anyone with read access to the repository can use this endpoint. GitHub Apps must have the `actions` permission to use this endpoint. + */ + getWorkflow: { + ( + params?: Octokit.RequestOptions & Octokit.ActionsGetWorkflowParams + ): Promise>; + + endpoint: Octokit.Endpoint; + }; + /** + * Gets a specific job in a workflow run. Anyone with read access to the repository can use this endpoint. GitHub Apps must have the `actions` permission to use this endpoint. + */ + getWorkflowJob: { + ( + params?: Octokit.RequestOptions & Octokit.ActionsGetWorkflowJobParams + ): Promise>; + + endpoint: Octokit.Endpoint; + }; + /** + * Gets a specific workflow run. Anyone with read access to the repository can use this endpoint. GitHub Apps must have the `actions` permission to use this endpoint. + */ + getWorkflowRun: { + ( + params?: Octokit.RequestOptions & Octokit.ActionsGetWorkflowRunParams + ): Promise>; + + endpoint: Octokit.Endpoint; + }; + /** + * Lists binaries for the self-hosted runner application that you can download and run. Anyone with admin access to the repository can use this endpoint. GitHub Apps must have the `administration` permission to use this endpoint. + */ + listDownloadsForSelfHostedRunnerApplication: { + ( + params?: Octokit.RequestOptions & + Octokit.ActionsListDownloadsForSelfHostedRunnerApplicationParams + ): Promise< + Octokit.Response< + Octokit.ActionsListDownloadsForSelfHostedRunnerApplicationResponse + > + >; + + endpoint: Octokit.Endpoint; + }; + /** + * Lists jobs for a workflow run. Anyone with read access to the repository can use this endpoint. GitHub Apps must have the `actions` permission to use this endpoint. + */ + listJobsForWorkflowRun: { + ( + params?: Octokit.RequestOptions & + Octokit.ActionsListJobsForWorkflowRunParams + ): Promise< + Octokit.Response + >; + + endpoint: Octokit.Endpoint; + }; + /** + * Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://developer.github.com/v3/#parameters). + * + * Anyone with read access to the repository can use this endpoint. GitHub Apps must have the `actions` permission to use this endpoint. + */ + listRepoWorkflowRuns: { + ( + params?: Octokit.RequestOptions & + Octokit.ActionsListRepoWorkflowRunsParams + ): Promise>; + + endpoint: Octokit.Endpoint; + }; + /** + * Lists the workflows in a repository. Anyone with read access to the repository can use this endpoint. GitHub Apps must have the `actions` permission to use this endpoint. + */ + listRepoWorkflows: { + ( + params?: Octokit.RequestOptions & Octokit.ActionsListRepoWorkflowsParams + ): Promise>; + + endpoint: Octokit.Endpoint; + }; + /** + * Lists all secrets available in a repository without revealing their encrypted values. Anyone with write access to the repository can use this endpoint. GitHub Apps must have the `secrets` permission to use this endpoint. + */ + listSecretsForRepo: { + ( + params?: Octokit.RequestOptions & + Octokit.ActionsListSecretsForRepoParams + ): Promise>; + + endpoint: Octokit.Endpoint; + }; + /** + * Lists all self-hosted runners for a repository. Anyone with admin access to the repository can use this endpoint. GitHub Apps must have the `administration` permission to use this endpoint. + */ + listSelfHostedRunnersForRepo: { + ( + params?: Octokit.RequestOptions & + Octokit.ActionsListSelfHostedRunnersForRepoParams + ): Promise< + Octokit.Response + >; + + endpoint: Octokit.Endpoint; + }; + /** + * Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look for `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can use this endpoint. GitHub Apps must have the `actions` permission to use this endpoint. + * + * Call this endpoint using the `-v` flag, which enables verbose output and allows you to see the download URL in the header. To download the file into the current working directory, specify the filename using the `-o` flag. + */ + listWorkflowJobLogs: { + ( + params?: Octokit.RequestOptions & + Octokit.ActionsListWorkflowJobLogsParams + ): Promise; + + endpoint: Octokit.Endpoint; + }; + /** + * Lists artifacts for a workflow run. Anyone with read access to the repository can use this endpoint. GitHub Apps must have the `actions` permission to use this endpoint. + */ + listWorkflowRunArtifacts: { + ( + params?: Octokit.RequestOptions & + Octokit.ActionsListWorkflowRunArtifactsParams + ): Promise< + Octokit.Response + >; + + endpoint: Octokit.Endpoint; + }; + /** + * Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can use this endpoint. GitHub Apps must have the `actions` permission to use this endpoint. + * + * Call this endpoint using the `-v` flag, which enables verbose output and allows you to see the download URL in the header. To download the file into the current working directory, specify the filename using the `-o` flag. + */ + listWorkflowRunLogs: { + ( + params?: Octokit.RequestOptions & + Octokit.ActionsListWorkflowRunLogsParams + ): Promise; + + endpoint: Octokit.Endpoint; + }; + /** + * List all workflow runs for a workflow. You can also replace `:workflow_id` with `:workflow_file_name`. For example, you could use `main.yml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://developer.github.com/v3/#parameters). + * + * Anyone with read access to the repository can use this endpoint. + */ + listWorkflowRuns: { + ( + params?: Octokit.RequestOptions & Octokit.ActionsListWorkflowRunsParams + ): Promise>; + + endpoint: Octokit.Endpoint; + }; + /** + * Re-runs your workflow run using its `id`. Anyone with write access to the repository can use this endpoint. GitHub Apps must have the `actions` permission to use this endpoint. + */ + reRunWorkflow: { + ( + params?: Octokit.RequestOptions & Octokit.ActionsReRunWorkflowParams + ): Promise; + + endpoint: Octokit.Endpoint; + }; + /** + * Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. Anyone with admin access to the repository can use this endpoint. GitHub Apps must have the `administration` permission to use this endpoint. + */ + removeSelfHostedRunner: { + ( + params?: Octokit.RequestOptions & + Octokit.ActionsRemoveSelfHostedRunnerParams + ): Promise; + + endpoint: Octokit.Endpoint; + }; + }; activity: { /** * Requires for the user to be authenticated. @@ -29228,6 +34047,17 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; + /** + * Requires for the user to be authenticated. + */ + checkWatchingRepoLegacy: { + ( + params?: Octokit.RequestOptions & + Octokit.ActivityCheckWatchingRepoLegacyParams + ): Promise; + + endpoint: Octokit.Endpoint; + }; /** * This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, [set the repository's subscription manually](https://developer.github.com/v3/activity/watching/#set-a-repository-subscription). */ @@ -29553,6 +34383,17 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; + /** + * Requires for the user to be authenticated. + */ + stopWatchingRepoLegacy: { + ( + params?: Octokit.RequestOptions & + Octokit.ActivityStopWatchingRepoLegacyParams + ): Promise; + + endpoint: Octokit.Endpoint; + }; /** * Requires for the user to be authenticated. */ @@ -29561,6 +34402,18 @@ declare class Octokit { params?: Octokit.RequestOptions & Octokit.ActivityUnstarRepoParams ): Promise; + endpoint: Octokit.Endpoint; + }; + /** + * Requires the user to be authenticated. + * + * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://developer.github.com/v3/#http-verbs)." + */ + watchRepoLegacy: { + ( + params?: Octokit.RequestOptions & Octokit.ActivityWatchRepoLegacyParams + ): Promise; + endpoint: Octokit.Endpoint; }; }; @@ -29661,9 +34514,7 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; /** - * Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. - * - * By default the installation token has access to all repositories that the installation can access. To restrict the access to specific repositories, you can provide the `repository_ids` when creating the token. When you omit `repository_ids`, the response does not contain the `repositories` key. + * Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. To restrict the access to specific repositories, you can provide the `repository_ids` when creating the token. When you omit `repository_ids`, the response does not contain the `repositories` key. * * You must use a [JWT](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. * @@ -30030,6 +34881,20 @@ declare class Octokit { Octokit.AppsRevokeGrantForApplicationParams ): Promise; + endpoint: Octokit.Endpoint; + }; + /** + * Revokes the installation token you're using to authenticate as an installation and access this endpoint. + * + * Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the "[Create a new installation token](https://developer.github.com/v3/apps/#create-a-new-installation-token)" endpoint. + * + * You must use an [installation access token](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. + */ + revokeInstallationToken: { + (params?: Octokit.RequestOptions & Octokit.EmptyParams): Promise< + Octokit.AnyResponse + >; + endpoint: Octokit.Endpoint; }; }; @@ -30586,11 +35451,13 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; /** - * If `truncated` is `true`, the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, you can clone the repository and iterate over the Git data locally. + * Returns a single tree using the SHA1 value for that tree. + * + * If `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, you can clone the repository and iterate over the Git data locally. */ getTree: { (params?: Octokit.RequestOptions & Octokit.GitGetTreeParams): Promise< - Octokit.AnyResponse + Octokit.Response >; endpoint: Octokit.Endpoint; @@ -31283,7 +36150,7 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; /** - * Deletes a previous migration archive. Downloadable migration archives are automatically deleted after seven days. Migration metadata, which is returned in the [Get a list of user migrations](https://developer.github.com/v3/migrations/users/#get-a-list-of-user-migrations) and [Get the status of a user migration](https://developer.github.com/v3/migrations/users/#get-the-status-of-a-user-migration) endpoints, will continue to be available even after an archive is deleted. + * Deletes a previous migration archive. Downloadable migration archives are automatically deleted after seven days. Migration metadata, which is returned in the [List user migrations](https://developer.github.com/v3/migrations/users/#list-user-migrations) and [Get the status of a user migration](https://developer.github.com/v3/migrations/users/#get-the-status-of-a-user-migration) endpoints, will continue to be available even after an archive is deleted. */ deleteArchiveForAuthenticatedUser: { ( @@ -31304,6 +36171,17 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; + /** + * Fetches the URL to a migration archive. + */ + downloadArchiveForOrg: { + ( + params?: Octokit.RequestOptions & + Octokit.MigrationsDownloadArchiveForOrgParams + ): Promise; + + endpoint: Octokit.Endpoint; + }; /** * Fetches the URL to download the migration archive as a `tar.gz` file. Depending on the resources your repository uses, the migration archive can contain JSON files with data for these objects: * @@ -31337,6 +36215,9 @@ declare class Octokit { }; /** * Fetches the URL to a migration archive. + * + * + * @deprecated octokit.migrations.getArchiveForOrg() has been renamed to octokit.migrations.downloadArchiveForOrg() (2020-01-27) */ getArchiveForOrg: { ( @@ -31377,7 +36258,7 @@ declare class Octokit { * If there are problems, you will see one of these in the `status` field: * * * `auth_failed` - the import requires authentication in order to connect to the original repository. To update authentication for the import, please see the [Update Existing Import](https://developer.github.com/v3/migrations/source_imports/#update-existing-import) section. - * * `error` - the import encountered an error. The import progress response will include the `failed_step` and an error message. Contact [GitHub Support](https://github.com/contact) for more information. + * * `error` - the import encountered an error. The import progress response will include the `failed_step` and an error message. Contact [GitHub Support](https://github.com/contact) or [GitHub Premium Support](https://premium.githubsupport.com) for more information. * * `detection_needs_auth` - the importer requires authentication for the originating repository to continue detection. To update authentication for the import, please see the [Update Existing Import](https://developer.github.com/v3/migrations/source_imports/#update-existing-import) section. * * `detection_found_nothing` - the importer didn't recognize any source control at the URL. To resolve, [Cancel the import](https://developer.github.com/v3/migrations/source_imports/#cancel-an-import) and [retry](https://developer.github.com/v3/migrations/source_imports/#start-an-import) with the correct URL. * * `detection_found_multiple` - the importer found several projects or repositories at the provided URL. When this is the case, the Import Progress response will also include a `project_choices` field with the possible project choices as values. To update project choice, please see the [Update Existing Import](https://developer.github.com/v3/migrations/source_imports/#update-existing-import) section. @@ -31476,6 +36357,28 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; + /** + * List all the repositories for this organization migration. + */ + listReposForOrg: { + ( + params?: Octokit.RequestOptions & + Octokit.MigrationsListReposForOrgParams + ): Promise>; + + endpoint: Octokit.Endpoint; + }; + /** + * Lists all the repositories for this user migration. + */ + listReposForUser: { + ( + params?: Octokit.RequestOptions & + Octokit.MigrationsListReposForUserParams + ): Promise>; + + endpoint: Octokit.Endpoint; + }; /** * Update an author's identity for the import. Your application can continue updating authors any time before you push new commits to the repository. */ @@ -31575,7 +36478,7 @@ declare class Octokit { * **Deprecation Notice:** GitHub will replace and discontinue OAuth endpoints containing `access_token` in the path parameter. We are introducing new endpoints that allow you to securely manage tokens for OAuth Apps by using `access_token` as an input parameter. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). * * OAuth applications can use a special API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://developer.github.com/v3/auth#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`. - * @deprecated octokit.apps.checkAuthorization() is deprecated, see https://developer.github.com/v3/apps/oauth_applications/#check-an-authorization + * @deprecated octokit.oauthAuthorizations.checkAuthorization() is deprecated, see https://developer.github.com/v3/apps/oauth_applications/#check-an-authorization */ checkAuthorization: { ( @@ -31765,7 +36668,7 @@ declare class Octokit { * **Deprecation Notice:** GitHub will replace and discontinue OAuth endpoints containing `access_token` in the path parameter. We are introducing new endpoints that allow you to securely manage tokens for OAuth Apps by using `access_token` as an input parameter. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). * * OAuth applications can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. You must use [Basic Authentication](https://developer.github.com/v3/auth#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`. - * @deprecated octokit.apps.resetAuthorization() is deprecated, see https://developer.github.com/v3/apps/oauth_applications/#reset-an-authorization + * @deprecated octokit.oauthAuthorizations.resetAuthorization() is deprecated, see https://developer.github.com/v3/apps/oauth_applications/#reset-an-authorization */ resetAuthorization: { ( @@ -31781,7 +36684,7 @@ declare class Octokit { * **Deprecation Notice:** GitHub will replace and discontinue OAuth endpoints containing `access_token` in the path parameter. We are introducing new endpoints that allow you to securely manage tokens for OAuth Apps by using `access_token` as an input parameter. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). * * OAuth application owners can revoke a single token for an OAuth application. You must use [Basic Authentication](https://developer.github.com/v3/auth#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. - * @deprecated octokit.apps.revokeAuthorizationForApplication() is deprecated, see https://developer.github.com/v3/apps/oauth_applications/#revoke-an-authorization-for-an-application + * @deprecated octokit.oauthAuthorizations.revokeAuthorizationForApplication() is deprecated, see https://developer.github.com/v3/apps/oauth_applications/#revoke-an-authorization-for-an-application */ revokeAuthorizationForApplication: { ( @@ -31797,7 +36700,7 @@ declare class Octokit { * OAuth application owners can revoke a grant for their OAuth application and a specific user. You must use [Basic Authentication](https://developer.github.com/v3/auth#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid token as `:access_token` and the grant for the token's owner will be deleted. * * Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the Applications settings page under "Authorized OAuth Apps" on GitHub](https://github.com/settings/applications#authorized). - * @deprecated octokit.apps.revokeGrantForApplication() is deprecated, see https://developer.github.com/v3/apps/oauth_applications/#revoke-a-grant-for-an-application + * @deprecated octokit.oauthAuthorizations.revokeGrantForApplication() is deprecated, see https://developer.github.com/v3/apps/oauth_applications/#revoke-a-grant-for-an-application */ revokeGrantForApplication: { ( @@ -32174,15 +37077,15 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; /** - * **Note:** The new `members_allowed_repository_creation_type` replaces the functionality of `members_can_create_repositories`. + * **Parameter Deprecation Notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). * - * Setting `members_allowed_repository_creation_type` will override the value of `members_can_create_repositories` in the following ways: - * - * * Setting `members_allowed_repository_creation_type` to `all` or `private` sets `members_can_create_repositories` to `true`. - * * Setting `members_allowed_repository_creation_type` to `none` sets `members_can_create_repositories` to `false`. - * * If you omit `members_allowed_repository_creation_type`, `members_can_create_repositories` is not modified. + * Enables an authenticated organization owner with the `admin:org` scope to update the organization's profile and member privileges. */ update: { + ( + params?: Octokit.RequestOptions & + Octokit.OrgsUpdateParamsDeprecatedMembersAllowedRepositoryCreationType + ): Promise>; (params?: Octokit.RequestOptions & Octokit.OrgsUpdateParams): Promise< Octokit.Response >; @@ -32457,7 +37360,7 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; /** - * Draft pull requests are available in public repositories with GitHub Free and GitHub Pro, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. + * Draft pull requests are available in public repositories with GitHub Free and GitHub Pro, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request. * @@ -32661,7 +37564,7 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; /** - * Draft pull requests are available in public repositories with GitHub Free and GitHub Pro, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. + * Draft pull requests are available in public repositories with GitHub Free and GitHub Pro, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Lists details of a pull request by providing its number. * @@ -32743,7 +37646,7 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; /** - * Draft pull requests are available in public repositories with GitHub Free and GitHub Pro, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. + * Draft pull requests are available in public repositories with GitHub Free and GitHub Pro, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ list: { (params?: Octokit.RequestOptions & Octokit.PullsListParams): Promise< @@ -32831,7 +37734,7 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; /** - * **Note:** The response includes a maximum of 300 files. + * **Note:** Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default. */ listFiles: { ( @@ -32897,7 +37800,7 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; /** - * Draft pull requests are available in public repositories with GitHub Free and GitHub Pro, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. + * Draft pull requests are available in public repositories with GitHub Free and GitHub Pro, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request. */ @@ -33051,7 +37954,10 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://developer.github.com/v3/reactions/#create-reaction-for-a-team-discussion) endpoint. + * * Create a reaction to a [team discussion](https://developer.github.com/v3/teams/discussions/). OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with a `Status: 200 OK` means that you already added the reaction type to this team discussion. + * @deprecated octokit.reactions.createForTeamDiscussion() is deprecated, see https://developer.github.com/v3/reactions/#create-reaction-for-a-team-discussion-legacy */ createForTeamDiscussion: { ( @@ -33064,7 +37970,10 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion comment`](https://developer.github.com/v3/reactions/#create-reaction-for-a-team-discussion-comment) endpoint. + * * Create a reaction to a [team discussion comment](https://developer.github.com/v3/teams/discussion_comments/). OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with a `Status: 200 OK` means that you already added the reaction type to this team discussion comment. + * @deprecated octokit.reactions.createForTeamDiscussionComment() is deprecated, see https://developer.github.com/v3/reactions/#create-reaction-for-a-team-discussion-comment-legacy */ createForTeamDiscussionComment: { ( @@ -33078,6 +37987,72 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; + /** + * Create a reaction to a [team discussion comment](https://developer.github.com/v3/teams/discussion_comments/). OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with a `Status: 200 OK` means that you already added the reaction type to this team discussion comment. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. + */ + createForTeamDiscussionCommentInOrg: { + ( + params?: Octokit.RequestOptions & + Octokit.ReactionsCreateForTeamDiscussionCommentInOrgParams + ): Promise< + Octokit.Response< + Octokit.ReactionsCreateForTeamDiscussionCommentInOrgResponse + > + >; + + endpoint: Octokit.Endpoint; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion comment`](https://developer.github.com/v3/reactions/#create-reaction-for-a-team-discussion-comment) endpoint. + * + * Create a reaction to a [team discussion comment](https://developer.github.com/v3/teams/discussion_comments/). OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with a `Status: 200 OK` means that you already added the reaction type to this team discussion comment. + * @deprecated octokit.reactions.createForTeamDiscussionCommentLegacy() is deprecated, see https://developer.github.com/v3/reactions/#create-reaction-for-a-team-discussion-comment-legacy + */ + createForTeamDiscussionCommentLegacy: { + ( + params?: Octokit.RequestOptions & + Octokit.ReactionsCreateForTeamDiscussionCommentLegacyParams + ): Promise< + Octokit.Response< + Octokit.ReactionsCreateForTeamDiscussionCommentLegacyResponse + > + >; + + endpoint: Octokit.Endpoint; + }; + /** + * Create a reaction to a [team discussion](https://developer.github.com/v3/teams/discussions/). OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with a `Status: 200 OK` means that you already added the reaction type to this team discussion. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. + */ + createForTeamDiscussionInOrg: { + ( + params?: Octokit.RequestOptions & + Octokit.ReactionsCreateForTeamDiscussionInOrgParams + ): Promise< + Octokit.Response + >; + + endpoint: Octokit.Endpoint; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://developer.github.com/v3/reactions/#create-reaction-for-a-team-discussion) endpoint. + * + * Create a reaction to a [team discussion](https://developer.github.com/v3/teams/discussions/). OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with a `Status: 200 OK` means that you already added the reaction type to this team discussion. + * @deprecated octokit.reactions.createForTeamDiscussionLegacy() is deprecated, see https://developer.github.com/v3/reactions/#create-reaction-for-a-team-discussion-legacy + */ + createForTeamDiscussionLegacy: { + ( + params?: Octokit.RequestOptions & + Octokit.ReactionsCreateForTeamDiscussionLegacyParams + ): Promise< + Octokit.Response + >; + + endpoint: Octokit.Endpoint; + }; /** * OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), when deleting a [team discussion](https://developer.github.com/v3/teams/discussions/) or [team discussion comment](https://developer.github.com/v3/teams/discussion_comments/). */ @@ -33144,7 +38119,10 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://developer.github.com/v3/reactions/#list-reactions-for-a-team-discussion) endpoint. + * * List the reactions to a [team discussion](https://developer.github.com/v3/teams/discussions/). OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @deprecated octokit.reactions.listForTeamDiscussion() is deprecated, see https://developer.github.com/v3/reactions/#list-reactions-for-a-team-discussion-legacy */ listForTeamDiscussion: { ( @@ -33157,7 +38135,10 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://developer.github.com/v3/reactions/#list-reactions-for-a-team-discussion-comment) endpoint. + * * List the reactions to a [team discussion comment](https://developer.github.com/v3/teams/discussion_comments/). OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @deprecated octokit.reactions.listForTeamDiscussionComment() is deprecated, see https://developer.github.com/v3/reactions/#list-reactions-for-a-team-discussion-comment-legacy */ listForTeamDiscussionComment: { ( @@ -33167,6 +38148,72 @@ declare class Octokit { Octokit.Response >; + endpoint: Octokit.Endpoint; + }; + /** + * List the reactions to a [team discussion comment](https://developer.github.com/v3/teams/discussion_comments/). OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. + */ + listForTeamDiscussionCommentInOrg: { + ( + params?: Octokit.RequestOptions & + Octokit.ReactionsListForTeamDiscussionCommentInOrgParams + ): Promise< + Octokit.Response< + Octokit.ReactionsListForTeamDiscussionCommentInOrgResponse + > + >; + + endpoint: Octokit.Endpoint; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://developer.github.com/v3/reactions/#list-reactions-for-a-team-discussion-comment) endpoint. + * + * List the reactions to a [team discussion comment](https://developer.github.com/v3/teams/discussion_comments/). OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @deprecated octokit.reactions.listForTeamDiscussionCommentLegacy() is deprecated, see https://developer.github.com/v3/reactions/#list-reactions-for-a-team-discussion-comment-legacy + */ + listForTeamDiscussionCommentLegacy: { + ( + params?: Octokit.RequestOptions & + Octokit.ReactionsListForTeamDiscussionCommentLegacyParams + ): Promise< + Octokit.Response< + Octokit.ReactionsListForTeamDiscussionCommentLegacyResponse + > + >; + + endpoint: Octokit.Endpoint; + }; + /** + * List the reactions to a [team discussion](https://developer.github.com/v3/teams/discussions/). OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. + */ + listForTeamDiscussionInOrg: { + ( + params?: Octokit.RequestOptions & + Octokit.ReactionsListForTeamDiscussionInOrgParams + ): Promise< + Octokit.Response + >; + + endpoint: Octokit.Endpoint; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://developer.github.com/v3/reactions/#list-reactions-for-a-team-discussion) endpoint. + * + * List the reactions to a [team discussion](https://developer.github.com/v3/teams/discussions/). OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @deprecated octokit.reactions.listForTeamDiscussionLegacy() is deprecated, see https://developer.github.com/v3/reactions/#list-reactions-for-a-team-discussion-legacy + */ + listForTeamDiscussionLegacy: { + ( + params?: Octokit.RequestOptions & + Octokit.ReactionsListForTeamDiscussionLegacyParams + ): Promise< + Octokit.Response + >; + endpoint: Octokit.Endpoint; }; }; @@ -33207,7 +38254,7 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; /** - * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. + * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Adding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. */ @@ -33224,7 +38271,7 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; /** - * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. + * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Grants the specified apps push access for this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. * @@ -33243,7 +38290,7 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; /** - * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. + * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * When authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits. */ @@ -33260,7 +38307,7 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; /** - * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. + * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ addProtectedBranchRequiredStatusChecksContexts: { ( @@ -33275,9 +38322,9 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; /** - * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. + * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Grants the specified teams push access for this branch. If you pass the `hellcat-preview` media type, you can also give push access to child teams. + * Grants the specified teams push access for this branch. You can also give push access to child teams. * * | Type | Description | * | ------- | ------------------------------------------------------------------------------------------------------------------------------------------ | @@ -33296,7 +38343,7 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; /** - * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. + * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Grants the specified people push access for this branch. * @@ -33319,7 +38366,7 @@ declare class Octokit { /** * For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. * - * If you pass the `hellcat-preview` media type, team members will include the members of child teams. + * Team members will include the members of child teams. */ checkCollaborator: { ( @@ -33504,7 +38551,7 @@ declare class Octokit { /** * Create a fork for the authenticated user. * - * **Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Support](https://github.com/contact). + * **Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Support](https://github.com/contact) or [GitHub Premium Support](https://premium.githubsupport.com). */ createFork: { ( @@ -33752,7 +38799,7 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; /** - * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. + * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Lists the GitHub Apps that have push access to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. */ @@ -33791,7 +38838,7 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; /** - * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. + * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ getBranchProtection: { ( @@ -34073,7 +39120,7 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; /** - * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. + * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ getProtectedBranchAdminEnforcement: { ( @@ -34088,7 +39135,7 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; /** - * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. + * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ getProtectedBranchPullRequestReviewEnforcement: { ( @@ -34103,7 +39150,7 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; /** - * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. + * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * When authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://help.github.com/articles/signing-commits-with-gpg) in GitHub Help. * @@ -34122,7 +39169,7 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; /** - * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. + * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ getProtectedBranchRequiredStatusChecks: { ( @@ -34137,7 +39184,7 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; /** - * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. + * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Lists who has access to this protected branch. {{#note}} * @@ -34212,9 +39259,9 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; /** - * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. + * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Lists the teams who have push access to this branch. If you pass the `hellcat-preview` media type, the list includes child teams. + * Lists the teams who have push access to this branch. The list includes child teams. */ getTeamsWithAccessToProtectedBranch: { ( @@ -34249,7 +39296,7 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; /** - * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. + * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Lists the people who have push access to this branch. */ @@ -34288,7 +39335,7 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; /** - * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. + * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Lists the GitHub Apps that have push access to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. * @deprecated octokit.repos.listAppsWithAccessToProtectedBranch() has been renamed to octokit.repos.getAppsWithAccessToProtectedBranch() (2019-09-13) @@ -34323,7 +39370,7 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; /** - * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. + * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Returns all branches where the given commit SHA is the HEAD, or latest commit for the branch. */ @@ -34340,7 +39387,7 @@ declare class Octokit { /** * For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. * - * If you pass the `hellcat-preview` media type, team members will include the members of child teams. + * Team members will include the members of child teams. */ listCollaborators: { ( @@ -34535,7 +39582,7 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; /** - * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. + * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ listProtectedBranchRequiredStatusChecksContexts: { ( @@ -34550,9 +39597,9 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; /** - * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. + * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Lists the teams who have push access to this branch. If you pass the `hellcat-preview` media type, the list includes child teams. + * Lists the teams who have push access to this branch. The list includes child teams. * @deprecated octokit.repos.listProtectedBranchTeamRestrictions() has been renamed to octokit.repos.getTeamsWithAccessToProtectedBranch() (2019-09-09) */ listProtectedBranchTeamRestrictions: { @@ -34568,7 +39615,7 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; /** - * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. + * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Lists the people who have push access to this branch. * @deprecated octokit.repos.listProtectedBranchUserRestrictions() has been renamed to octokit.repos.getUsersWithAccessToProtectedBranch() (2019-09-09) @@ -34653,9 +39700,9 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; /** - * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. + * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Lists the teams who have push access to this branch. If you pass the `hellcat-preview` media type, the list includes child teams. + * Lists the teams who have push access to this branch. The list includes child teams. * @deprecated octokit.repos.listTeamsWithAccessToProtectedBranch() has been renamed to octokit.repos.getTeamsWithAccessToProtectedBranch() (2019-09-13) */ listTeamsWithAccessToProtectedBranch: { @@ -34679,7 +39726,7 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; /** - * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. + * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Lists the people who have push access to this branch. * @deprecated octokit.repos.listUsersWithAccessToProtectedBranch() has been renamed to octokit.repos.getUsersWithAccessToProtectedBranch() (2019-09-13) @@ -34715,7 +39762,7 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; /** - * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. + * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ removeBranchProtection: { ( @@ -34742,7 +39789,7 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; /** - * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. + * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Removing admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. */ @@ -34755,7 +39802,7 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; /** - * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. + * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Removes the ability of an app to push to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. * @@ -34776,7 +39823,7 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; /** - * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. + * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ removeProtectedBranchPullRequestReviewEnforcement: { ( @@ -34787,7 +39834,7 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; /** - * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. + * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * When authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits. */ @@ -34800,7 +39847,7 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; /** - * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. + * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ removeProtectedBranchRequiredStatusChecks: { ( @@ -34811,7 +39858,7 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; /** - * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. + * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ removeProtectedBranchRequiredStatusChecksContexts: { ( @@ -34826,7 +39873,7 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; /** - * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. + * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Disables the ability to restrict who can push to this branch. */ @@ -34839,9 +39886,9 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; /** - * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. + * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Removes the ability of a team to push to this branch. If you pass the `hellcat-preview` media type, you can include child teams. + * Removes the ability of a team to push to this branch. You can also remove push access for child teams. * * | Type | Description | * | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | @@ -34860,7 +39907,7 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; /** - * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. + * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Removes the ability of a user to push to this branch. * @@ -34881,7 +39928,7 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; /** - * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. + * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Replaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. * @@ -34902,7 +39949,7 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; /** - * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. + * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ replaceProtectedBranchRequiredStatusChecksContexts: { ( @@ -34917,9 +39964,9 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; /** - * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. + * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Replaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. If you pass the `hellcat-preview` media type, you can include child teams. + * Replaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams. * * | Type | Description | * | ------- | ------------------------------------------------------------------------------------------------------------------------------------------ | @@ -34938,7 +39985,7 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; /** - * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. + * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Replaces the list of people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people. * @@ -35024,7 +40071,7 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; /** - * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. + * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Protecting a branch requires admin or owner permissions to the repository. * @@ -35085,7 +40132,7 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; /** - * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. + * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Updating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled. * @@ -35104,7 +40151,7 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; /** - * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. + * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled. */ @@ -35152,6 +40199,10 @@ declare class Octokit { * GitHub expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example, you'll still need to pass your authentication to be able to upload an asset. */ uploadReleaseAsset: { + ( + params?: Octokit.RequestOptions & + Octokit.ReposUploadReleaseAssetParamsDeprecatedFile + ): Promise>; ( params?: Octokit.RequestOptions & Octokit.ReposUploadReleaseAssetParams ): Promise>; @@ -35204,6 +40255,17 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; + /** + * This API call is added for compatibility reasons only. There's no guarantee that full email searches will always be available. The `@` character in the address must be left unencoded. Searches only against public email addresses (as configured on the user's GitHub profile). + * @deprecated octokit.search.emailLegacy() is deprecated, see https://developer.github.com/v3/search/legacy/#email-search + */ + emailLegacy: { + ( + params?: Octokit.RequestOptions & Octokit.SearchEmailLegacyParams + ): Promise>; + + endpoint: Octokit.Endpoint; + }; /** * Find issues by state and keyword. This method returns up to 100 results [per page](https://developer.github.com/v3/#pagination). * @@ -35238,6 +40300,17 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; + /** + * Find issues by state and keyword. + * @deprecated octokit.search.issuesLegacy() is deprecated, see https://developer.github.com/v3/search/legacy/#search-issues + */ + issuesLegacy: { + ( + params?: Octokit.RequestOptions & Octokit.SearchIssuesLegacyParams + ): Promise>; + + endpoint: Octokit.Endpoint; + }; /** * Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://developer.github.com/v3/#pagination). * @@ -35272,6 +40345,17 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; + /** + * Find repositories by keyword. Note, this legacy method does not follow the v3 pagination pattern. This method returns up to 100 results per page and pages can be fetched using the `start_page` parameter. + * @deprecated octokit.search.reposLegacy() is deprecated, see https://developer.github.com/v3/search/legacy/#search-repositories + */ + reposLegacy: { + ( + params?: Octokit.RequestOptions & Octokit.SearchReposLegacyParams + ): Promise>; + + endpoint: Octokit.Endpoint; + }; /** * Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://developer.github.com/v3/#pagination). * @@ -35306,23 +40390,34 @@ declare class Octokit { Octokit.Response >; + endpoint: Octokit.Endpoint; + }; + /** + * Find users by keyword. + * @deprecated octokit.search.usersLegacy() is deprecated, see https://developer.github.com/v3/search/legacy/#search-users + */ + usersLegacy: { + ( + params?: Octokit.RequestOptions & Octokit.SearchUsersLegacyParams + ): Promise>; + endpoint: Octokit.Endpoint; }; }; teams: { /** - * The "Add team member" API (described below) is deprecated. + * The "Add team member" endpoint (described below) is deprecated. * - * We recommend using the [Add team membership API](https://developer.github.com/v3/teams/members/#add-or-update-team-membership) instead. It allows you to invite new organization members to your teams. + * We recommend using the [Add team membership](https://developer.github.com/v3/teams/members/#add-or-update-team-membership) endpoint instead. It allows you to invite new organization members to your teams. * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/articles/github-s-products) in the GitHub Help documentation. + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * To add someone to a team, the authenticated user must be a team maintainer in the team they're changing or be an owner of the organization that the team is associated with. The person being added to the team must be a member of the team's organization. + * To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization. * * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." * * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://developer.github.com/v3/#http-verbs)." - * @deprecated octokit.teams.addMember() is deprecated, see https://developer.github.com/v3/teams/members/#add-team-member + * @deprecated octokit.teams.addMember() is deprecated, see https://developer.github.com/v3/teams/members/#add-team-member-legacy */ addMember: { (params?: Octokit.RequestOptions & Octokit.TeamsAddMemberParams): Promise< @@ -35332,15 +40427,39 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; /** - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/articles/github-s-products) in the GitHub Help documentation. + * The "Add team member" endpoint (described below) is deprecated. * - * If the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a maintainer of the team. + * We recommend using the [Add team membership](https://developer.github.com/v3/teams/members/#add-or-update-team-membership) endpoint instead. It allows you to invite new organization members to your teams. + * + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization. + * + * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * + * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://developer.github.com/v3/#http-verbs)." + * @deprecated octokit.teams.addMemberLegacy() is deprecated, see https://developer.github.com/v3/teams/members/#add-team-member-legacy + */ + addMemberLegacy: { + ( + params?: Octokit.RequestOptions & Octokit.TeamsAddMemberLegacyParams + ): Promise>; + + endpoint: Octokit.Endpoint; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Add or update team membership`](https://developer.github.com/v3/teams/members/#add-or-update-team-membership) endpoint. + * + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * If the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer. * * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." * * If the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the "pending" state until the user accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner. * - * If the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a maintainer of the team. + * If the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer. + * @deprecated octokit.teams.addOrUpdateMembership() is deprecated, see https://developer.github.com/v3/teams/members/#add-or-update-team-membership-legacy */ addOrUpdateMembership: { ( @@ -35351,7 +40470,57 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; /** + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team. + * + * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * + * An organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the "pending" state until the person accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. + * + * If the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/:org_id/team/:team_id/memberships/:username`. + */ + addOrUpdateMembershipInOrg: { + ( + params?: Octokit.RequestOptions & + Octokit.TeamsAddOrUpdateMembershipInOrgParams + ): Promise< + Octokit.Response + >; + + endpoint: Octokit.Endpoint; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Add or update team membership`](https://developer.github.com/v3/teams/members/#add-or-update-team-membership) endpoint. + * + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * If the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer. + * + * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * + * If the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the "pending" state until the user accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner. + * + * If the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer. + * @deprecated octokit.teams.addOrUpdateMembershipLegacy() is deprecated, see https://developer.github.com/v3/teams/members/#add-or-update-team-membership-legacy + */ + addOrUpdateMembershipLegacy: { + ( + params?: Octokit.RequestOptions & + Octokit.TeamsAddOrUpdateMembershipLegacyParams + ): Promise< + Octokit.Response + >; + + endpoint: Octokit.Endpoint; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Add or update team project`](https://developer.github.com/v3/teams/#add-or-update-team-project) endpoint. + * * Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. + * @deprecated octokit.teams.addOrUpdateProject() is deprecated, see https://developer.github.com/v3/teams/#add-or-update-team-project-legacy */ addOrUpdateProject: { ( @@ -35361,11 +40530,43 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; /** + * Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/:org_id/team/:team_id/projects/:project_id`. + */ + addOrUpdateProjectInOrg: { + ( + params?: Octokit.RequestOptions & + Octokit.TeamsAddOrUpdateProjectInOrgParams + ): Promise< + Octokit.Response + >; + + endpoint: Octokit.Endpoint; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Add or update team project`](https://developer.github.com/v3/teams/#add-or-update-team-project) endpoint. + * + * Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. + * @deprecated octokit.teams.addOrUpdateProjectLegacy() is deprecated, see https://developer.github.com/v3/teams/#add-or-update-team-project-legacy + */ + addOrUpdateProjectLegacy: { + ( + params?: Octokit.RequestOptions & + Octokit.TeamsAddOrUpdateProjectLegacyParams + ): Promise< + Octokit.Response + >; + + endpoint: Octokit.Endpoint; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Add or update team repository`](https://developer.github.com/v3/teams/#add-or-update-team-repository) endpoint. + * * To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. * - * If you pass the `hellcat-preview` media type, you can modify repository permissions of child teams. - * * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://developer.github.com/v3/#http-verbs)." + * @deprecated octokit.teams.addOrUpdateRepo() is deprecated, see https://developer.github.com/v3/teams/#add-or-update-team-repository-legacy */ addOrUpdateRepo: { ( @@ -35375,9 +40576,41 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; /** - * **Note**: If you pass the `hellcat-preview` media type, repositories inherited through a parent team will be checked. + * To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://developer.github.com/v3/#http-verbs)." + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/:org_id/team/:team_id/repos/:owner/:repo`. + */ + addOrUpdateRepoInOrg: { + ( + params?: Octokit.RequestOptions & + Octokit.TeamsAddOrUpdateRepoInOrgParams + ): Promise; + + endpoint: Octokit.Endpoint; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Add or update team repository`](https://developer.github.com/v3/teams/#add-or-update-team-repository) endpoint. + * + * To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. + * + * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://developer.github.com/v3/#http-verbs)." + * @deprecated octokit.teams.addOrUpdateRepoLegacy() is deprecated, see https://developer.github.com/v3/teams/#add-or-update-team-repository-legacy + */ + addOrUpdateRepoLegacy: { + ( + params?: Octokit.RequestOptions & + Octokit.TeamsAddOrUpdateRepoLegacyParams + ): Promise; + + endpoint: Octokit.Endpoint; + }; + /** + * **Note**: Repositories inherited through a parent team will also be checked. + * + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Check if a team manages a repository`](https://developer.github.com/v3/teams/#check-if-a-team-manages-a-repository) endpoint. * * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://developer.github.com/v3/media/) via the `Accept` header: + * @deprecated octokit.teams.checkManagesRepo() is deprecated, see https://developer.github.com/v3/teams/#check-if-a-team-manages-a-repository-legacy */ checkManagesRepo: { ( @@ -35386,8 +40619,41 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; + /** + * Checks whether a team has `admin`, `push`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/repos/:owner/:repo`. + * + * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://developer.github.com/v3/media/) via the `Accept` header: + */ + checkManagesRepoInOrg: { + ( + params?: Octokit.RequestOptions & + Octokit.TeamsCheckManagesRepoInOrgParams + ): Promise>; + + endpoint: Octokit.Endpoint; + }; + /** + * **Note**: Repositories inherited through a parent team will also be checked. + * + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Check if a team manages a repository`](https://developer.github.com/v3/teams/#check-if-a-team-manages-a-repository) endpoint. + * + * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://developer.github.com/v3/media/) via the `Accept` header: + * @deprecated octokit.teams.checkManagesRepoLegacy() is deprecated, see https://developer.github.com/v3/teams/#check-if-a-team-manages-a-repository-legacy + */ + checkManagesRepoLegacy: { + ( + params?: Octokit.RequestOptions & + Octokit.TeamsCheckManagesRepoLegacyParams + ): Promise>; + + endpoint: Octokit.Endpoint; + }; /** * To create a team, the authenticated user must be a member or owner of `:org`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see "[Setting team creation permissions](https://help.github.com/en/articles/setting-team-creation-permissions-in-your-organization)." + * + * When you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see "[About teams](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/about-teams)" in the GitHub Help documentation. */ create: { ( @@ -35401,9 +40667,12 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://developer.github.com/v3/teams/discussions/#create-a-discussion) endpoint. + * * Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)" for details. + * @deprecated octokit.teams.createDiscussion() is deprecated, see https://developer.github.com/v3/teams/discussions/#create-a-discussion-legacy */ createDiscussion: { ( @@ -35413,9 +40682,12 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a comment`](https://developer.github.com/v3/teams/discussion_comments/#create-a-comment) endpoint. + * * Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)" for details. + * @deprecated octokit.teams.createDiscussionComment() is deprecated, see https://developer.github.com/v3/teams/discussion_comments/#create-a-comment-legacy */ createDiscussionComment: { ( @@ -35428,9 +40700,78 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; /** - * To delete a team, the authenticated user must be a team maintainer or an owner of the org associated with the team. + * Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * - * If you are an organization owner and you pass the `hellcat-preview` media type, deleting a parent team will delete all of its child teams as well. + * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)" for details. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments`. + */ + createDiscussionCommentInOrg: { + ( + params?: Octokit.RequestOptions & + Octokit.TeamsCreateDiscussionCommentInOrgParams + ): Promise< + Octokit.Response + >; + + endpoint: Octokit.Endpoint; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a comment`](https://developer.github.com/v3/teams/discussion_comments/#create-a-comment) endpoint. + * + * Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * + * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)" for details. + * @deprecated octokit.teams.createDiscussionCommentLegacy() is deprecated, see https://developer.github.com/v3/teams/discussion_comments/#create-a-comment-legacy + */ + createDiscussionCommentLegacy: { + ( + params?: Octokit.RequestOptions & + Octokit.TeamsCreateDiscussionCommentLegacyParams + ): Promise< + Octokit.Response + >; + + endpoint: Octokit.Endpoint; + }; + /** + * Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * + * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)" for details. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions`. + */ + createDiscussionInOrg: { + ( + params?: Octokit.RequestOptions & + Octokit.TeamsCreateDiscussionInOrgParams + ): Promise>; + + endpoint: Octokit.Endpoint; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://developer.github.com/v3/teams/discussions/#create-a-discussion) endpoint. + * + * Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * + * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)" for details. + * @deprecated octokit.teams.createDiscussionLegacy() is deprecated, see https://developer.github.com/v3/teams/discussions/#create-a-discussion-legacy + */ + createDiscussionLegacy: { + ( + params?: Octokit.RequestOptions & + Octokit.TeamsCreateDiscussionLegacyParams + ): Promise>; + + endpoint: Octokit.Endpoint; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete team`](https://developer.github.com/v3/teams/#delete-team) endpoint. + * + * To delete a team, the authenticated user must be an organization owner or team maintainer. + * + * If you are an organization owner, deleting a parent team will delete all of its child teams as well. + * @deprecated octokit.teams.delete() is deprecated, see https://developer.github.com/v3/teams/#delete-team-legacy */ delete: { (params?: Octokit.RequestOptions & Octokit.TeamsDeleteParams): Promise< @@ -35440,7 +40781,10 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://developer.github.com/v3/teams/discussions/#delete-a-discussion) endpoint. + * * Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @deprecated octokit.teams.deleteDiscussion() is deprecated, see https://developer.github.com/v3/teams/discussions/#delete-a-discussion-legacy */ deleteDiscussion: { ( @@ -35450,7 +40794,10 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a comment`](https://developer.github.com/v3/teams/discussion_comments/#delete-a-comment) endpoint. + * * Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @deprecated octokit.teams.deleteDiscussionComment() is deprecated, see https://developer.github.com/v3/teams/discussion_comments/#delete-a-comment-legacy */ deleteDiscussionComment: { ( @@ -35460,7 +40807,93 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; + /** + * Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number`. + */ + deleteDiscussionCommentInOrg: { + ( + params?: Octokit.RequestOptions & + Octokit.TeamsDeleteDiscussionCommentInOrgParams + ): Promise; + endpoint: Octokit.Endpoint; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a comment`](https://developer.github.com/v3/teams/discussion_comments/#delete-a-comment) endpoint. + * + * Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @deprecated octokit.teams.deleteDiscussionCommentLegacy() is deprecated, see https://developer.github.com/v3/teams/discussion_comments/#delete-a-comment-legacy + */ + deleteDiscussionCommentLegacy: { + ( + params?: Octokit.RequestOptions & + Octokit.TeamsDeleteDiscussionCommentLegacyParams + ): Promise; + + endpoint: Octokit.Endpoint; + }; + /** + * Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number`. + */ + deleteDiscussionInOrg: { + ( + params?: Octokit.RequestOptions & + Octokit.TeamsDeleteDiscussionInOrgParams + ): Promise; + + endpoint: Octokit.Endpoint; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://developer.github.com/v3/teams/discussions/#delete-a-discussion) endpoint. + * + * Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @deprecated octokit.teams.deleteDiscussionLegacy() is deprecated, see https://developer.github.com/v3/teams/discussions/#delete-a-discussion-legacy + */ + deleteDiscussionLegacy: { + ( + params?: Octokit.RequestOptions & + Octokit.TeamsDeleteDiscussionLegacyParams + ): Promise; + + endpoint: Octokit.Endpoint; + }; + /** + * To delete a team, the authenticated user must be an organization owner or team maintainer. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/:org_id/team/:team_id`. + * + * If you are an organization owner, deleting a parent team will delete all of its child teams as well. + */ + deleteInOrg: { + ( + params?: Octokit.RequestOptions & Octokit.TeamsDeleteInOrgParams + ): Promise; + + endpoint: Octokit.Endpoint; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete team`](https://developer.github.com/v3/teams/#delete-team) endpoint. + * + * To delete a team, the authenticated user must be an organization owner or team maintainer. + * + * If you are an organization owner, deleting a parent team will delete all of its child teams as well. + * @deprecated octokit.teams.deleteLegacy() is deprecated, see https://developer.github.com/v3/teams/#delete-team-legacy + */ + deleteLegacy: { + ( + params?: Octokit.RequestOptions & Octokit.TeamsDeleteLegacyParams + ): Promise; + + endpoint: Octokit.Endpoint; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [`Get team by name`](https://developer.github.com/v3/teams/#get-team-by-name) endpoint. + * @deprecated octokit.teams.get() is deprecated, see https://developer.github.com/v3/teams/#get-team-legacy + */ get: { (params?: Octokit.RequestOptions & Octokit.TeamsGetParams): Promise< Octokit.Response @@ -35470,6 +40903,8 @@ declare class Octokit { }; /** * Gets a team using the team's `slug`. GitHub generates the `slug` from the team `name`. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id`. */ getByName: { (params?: Octokit.RequestOptions & Octokit.TeamsGetByNameParams): Promise< @@ -35479,7 +40914,10 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Get a single discussion`](https://developer.github.com/v3/teams/discussions/#get-a-single-discussion) endpoint. + * * Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @deprecated octokit.teams.getDiscussion() is deprecated, see https://developer.github.com/v3/teams/discussions/#get-a-single-discussion-legacy */ getDiscussion: { ( @@ -35489,7 +40927,10 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Get a single comment`](https://developer.github.com/v3/teams/discussion_comments/#get-a-single-comment) endpoint. + * * Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @deprecated octokit.teams.getDiscussionComment() is deprecated, see https://developer.github.com/v3/teams/discussion_comments/#get-a-single-comment-legacy */ getDiscussionComment: { ( @@ -35500,12 +40941,79 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; /** - * The "Get team member" API (described below) is deprecated. + * Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * - * We recommend using the [Get team membership API](https://developer.github.com/v3/teams/members/#get-team-membership) instead. It allows you to get both active and pending memberships. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number`. + */ + getDiscussionCommentInOrg: { + ( + params?: Octokit.RequestOptions & + Octokit.TeamsGetDiscussionCommentInOrgParams + ): Promise< + Octokit.Response + >; + + endpoint: Octokit.Endpoint; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Get a single comment`](https://developer.github.com/v3/teams/discussion_comments/#get-a-single-comment) endpoint. + * + * Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @deprecated octokit.teams.getDiscussionCommentLegacy() is deprecated, see https://developer.github.com/v3/teams/discussion_comments/#get-a-single-comment-legacy + */ + getDiscussionCommentLegacy: { + ( + params?: Octokit.RequestOptions & + Octokit.TeamsGetDiscussionCommentLegacyParams + ): Promise< + Octokit.Response + >; + + endpoint: Octokit.Endpoint; + }; + /** + * Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number`. + */ + getDiscussionInOrg: { + ( + params?: Octokit.RequestOptions & Octokit.TeamsGetDiscussionInOrgParams + ): Promise>; + + endpoint: Octokit.Endpoint; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Get a single discussion`](https://developer.github.com/v3/teams/discussions/#get-a-single-discussion) endpoint. + * + * Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @deprecated octokit.teams.getDiscussionLegacy() is deprecated, see https://developer.github.com/v3/teams/discussions/#get-a-single-discussion-legacy + */ + getDiscussionLegacy: { + ( + params?: Octokit.RequestOptions & Octokit.TeamsGetDiscussionLegacyParams + ): Promise>; + + endpoint: Octokit.Endpoint; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [`Get team by name`](https://developer.github.com/v3/teams/#get-team-by-name) endpoint. + * @deprecated octokit.teams.getLegacy() is deprecated, see https://developer.github.com/v3/teams/#get-team-legacy + */ + getLegacy: { + (params?: Octokit.RequestOptions & Octokit.TeamsGetLegacyParams): Promise< + Octokit.Response + >; + + endpoint: Octokit.Endpoint; + }; + /** + * The "Get team member" endpoint (described below) is deprecated. + * + * We recommend using the [Get team membership](https://developer.github.com/v3/teams/members/#get-team-membership) endpoint instead. It allows you to get both active and pending memberships. * * To list members in a team, the team must be visible to the authenticated user. - * @deprecated octokit.teams.getMember() is deprecated, see https://developer.github.com/v3/teams/members/#get-team-member + * @deprecated octokit.teams.getMember() is deprecated, see https://developer.github.com/v3/teams/members/#get-team-member-legacy */ getMember: { (params?: Octokit.RequestOptions & Octokit.TeamsGetMemberParams): Promise< @@ -35515,11 +41023,29 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; /** - * If you pass the `hellcat-preview` media type, team members will include the members of child teams. + * The "Get team member" endpoint (described below) is deprecated. + * + * We recommend using the [Get team membership](https://developer.github.com/v3/teams/members/#get-team-membership) endpoint instead. It allows you to get both active and pending memberships. + * + * To list members in a team, the team must be visible to the authenticated user. + * @deprecated octokit.teams.getMemberLegacy() is deprecated, see https://developer.github.com/v3/teams/members/#get-team-member-legacy + */ + getMemberLegacy: { + ( + params?: Octokit.RequestOptions & Octokit.TeamsGetMemberLegacyParams + ): Promise; + + endpoint: Octokit.Endpoint; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Get team membership`](https://developer.github.com/v3/teams/members/#get-team-membership) endpoint. + * + * Team members will include the members of child teams. * * To get a user's membership with a team, the team must be visible to the authenticated user. * * **Note:** The `role` for organization owners returns as `maintainer`. For more information about `maintainer` roles, see [Create team](https://developer.github.com/v3/teams#create-team). + * @deprecated octokit.teams.getMembership() is deprecated, see https://developer.github.com/v3/teams/members/#get-team-membership-legacy */ getMembership: { ( @@ -35528,7 +41054,42 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; + /** + * Team members will include the members of child teams. + * + * To get a user's membership with a team, the team must be visible to the authenticated user. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/memberships/:username`. + * + * **Note:** The `role` for organization owners returns as `maintainer`. For more information about `maintainer` roles, see [Create team](https://developer.github.com/v3/teams#create-team). + */ + getMembershipInOrg: { + ( + params?: Octokit.RequestOptions & Octokit.TeamsGetMembershipInOrgParams + ): Promise>; + endpoint: Octokit.Endpoint; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Get team membership`](https://developer.github.com/v3/teams/members/#get-team-membership) endpoint. + * + * Team members will include the members of child teams. + * + * To get a user's membership with a team, the team must be visible to the authenticated user. + * + * **Note:** The `role` for organization owners returns as `maintainer`. For more information about `maintainer` roles, see [Create team](https://developer.github.com/v3/teams#create-team). + * @deprecated octokit.teams.getMembershipLegacy() is deprecated, see https://developer.github.com/v3/teams/members/#get-team-membership-legacy + */ + getMembershipLegacy: { + ( + params?: Octokit.RequestOptions & Octokit.TeamsGetMembershipLegacyParams + ): Promise>; + + endpoint: Octokit.Endpoint; + }; + /** + * Lists all teams in an organization that are visible to the authenticated user. + */ list: { (params?: Octokit.RequestOptions & Octokit.TeamsListParams): Promise< Octokit.Response @@ -35537,7 +41098,10 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; /** - * At this time, the `hellcat-preview` media type is required to use this endpoint. + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://developer.github.com/v3/teams/#list-child-teams) endpoint. + * + * + * @deprecated octokit.teams.listChild() is deprecated, see https://developer.github.com/v3/teams/#list-child-teams-legacy */ listChild: { (params?: Octokit.RequestOptions & Octokit.TeamsListChildParams): Promise< @@ -35547,7 +41111,35 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; /** + * Lists the child teams of the team requested by `:team_slug`. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/teams`. + */ + listChildInOrg: { + ( + params?: Octokit.RequestOptions & Octokit.TeamsListChildInOrgParams + ): Promise>; + + endpoint: Octokit.Endpoint; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://developer.github.com/v3/teams/#list-child-teams) endpoint. + * + * + * @deprecated octokit.teams.listChildLegacy() is deprecated, see https://developer.github.com/v3/teams/#list-child-teams-legacy + */ + listChildLegacy: { + ( + params?: Octokit.RequestOptions & Octokit.TeamsListChildLegacyParams + ): Promise>; + + endpoint: Octokit.Endpoint; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List comments`](https://developer.github.com/v3/teams/discussion_comments/#list-comments) endpoint. + * * List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @deprecated octokit.teams.listDiscussionComments() is deprecated, see https://developer.github.com/v3/teams/discussion_comments/#list-comments-legacy */ listDiscussionComments: { ( @@ -35558,7 +41150,41 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; /** + * List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments`. + */ + listDiscussionCommentsInOrg: { + ( + params?: Octokit.RequestOptions & + Octokit.TeamsListDiscussionCommentsInOrgParams + ): Promise< + Octokit.Response + >; + + endpoint: Octokit.Endpoint; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List comments`](https://developer.github.com/v3/teams/discussion_comments/#list-comments) endpoint. + * + * List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @deprecated octokit.teams.listDiscussionCommentsLegacy() is deprecated, see https://developer.github.com/v3/teams/discussion_comments/#list-comments-legacy + */ + listDiscussionCommentsLegacy: { + ( + params?: Octokit.RequestOptions & + Octokit.TeamsListDiscussionCommentsLegacyParams + ): Promise< + Octokit.Response + >; + + endpoint: Octokit.Endpoint; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://developer.github.com/v3/teams/discussions/#list-discussions) endpoint. + * * List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @deprecated octokit.teams.listDiscussions() is deprecated, see https://developer.github.com/v3/teams/discussions/#list-discussions-legacy */ listDiscussions: { ( @@ -35567,6 +41193,33 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; + /** + * List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions`. + */ + listDiscussionsInOrg: { + ( + params?: Octokit.RequestOptions & + Octokit.TeamsListDiscussionsInOrgParams + ): Promise>; + + endpoint: Octokit.Endpoint; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://developer.github.com/v3/teams/discussions/#list-discussions) endpoint. + * + * List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @deprecated octokit.teams.listDiscussionsLegacy() is deprecated, see https://developer.github.com/v3/teams/discussions/#list-discussions-legacy + */ + listDiscussionsLegacy: { + ( + params?: Octokit.RequestOptions & + Octokit.TeamsListDiscussionsLegacyParams + ): Promise>; + + endpoint: Octokit.Endpoint; + }; /** * List all of the teams across all of the organizations to which the authenticated user belongs. This method requires `user`, `repo`, or `read:org` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/) when authenticating via [OAuth](https://developer.github.com/apps/building-oauth-apps/). */ @@ -35581,7 +41234,10 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; /** - * If you pass the `hellcat-preview` media type, team members will include the members of child teams. + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://developer.github.com/v3/teams/members/#list-team-members) endpoint. + * + * Team members will include the members of child teams. + * @deprecated octokit.teams.listMembers() is deprecated, see https://developer.github.com/v3/teams/members/#list-team-members-legacy */ listMembers: { ( @@ -35591,7 +41247,35 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; /** + * Team members will include the members of child teams. + * + * To list members in a team, the team must be visible to the authenticated user. + */ + listMembersInOrg: { + ( + params?: Octokit.RequestOptions & Octokit.TeamsListMembersInOrgParams + ): Promise>; + + endpoint: Octokit.Endpoint; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://developer.github.com/v3/teams/members/#list-team-members) endpoint. + * + * Team members will include the members of child teams. + * @deprecated octokit.teams.listMembersLegacy() is deprecated, see https://developer.github.com/v3/teams/members/#list-team-members-legacy + */ + listMembersLegacy: { + ( + params?: Octokit.RequestOptions & Octokit.TeamsListMembersLegacyParams + ): Promise>; + + endpoint: Octokit.Endpoint; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://developer.github.com/v3/teams/members/#list-pending-team-invitations) endpoint. + * * The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. + * @deprecated octokit.teams.listPendingInvitations() is deprecated, see https://developer.github.com/v3/teams/members/#list-pending-team-invitations-legacy */ listPendingInvitations: { ( @@ -35602,7 +41286,41 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; /** - * Lists the organization projects for a team. If you pass the `hellcat-preview` media type, the response will include projects inherited from a parent team. + * The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/invitations`. + */ + listPendingInvitationsInOrg: { + ( + params?: Octokit.RequestOptions & + Octokit.TeamsListPendingInvitationsInOrgParams + ): Promise< + Octokit.Response + >; + + endpoint: Octokit.Endpoint; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://developer.github.com/v3/teams/members/#list-pending-team-invitations) endpoint. + * + * The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. + * @deprecated octokit.teams.listPendingInvitationsLegacy() is deprecated, see https://developer.github.com/v3/teams/members/#list-pending-team-invitations-legacy + */ + listPendingInvitationsLegacy: { + ( + params?: Octokit.RequestOptions & + Octokit.TeamsListPendingInvitationsLegacyParams + ): Promise< + Octokit.Response + >; + + endpoint: Octokit.Endpoint; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://developer.github.com/v3/teams/#list-team-projects) endpoint. + * + * Lists the organization projects for a team. + * @deprecated octokit.teams.listProjects() is deprecated, see https://developer.github.com/v3/teams/#list-team-projects-legacy */ listProjects: { ( @@ -35612,7 +41330,33 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; /** - * **Note**: If you pass the `hellcat-preview` media type, the response will include any repositories inherited through a parent team. + * Lists the organization projects for a team. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/projects`. + */ + listProjectsInOrg: { + ( + params?: Octokit.RequestOptions & Octokit.TeamsListProjectsInOrgParams + ): Promise>; + + endpoint: Octokit.Endpoint; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://developer.github.com/v3/teams/#list-team-projects) endpoint. + * + * Lists the organization projects for a team. + * @deprecated octokit.teams.listProjectsLegacy() is deprecated, see https://developer.github.com/v3/teams/#list-team-projects-legacy + */ + listProjectsLegacy: { + ( + params?: Octokit.RequestOptions & Octokit.TeamsListProjectsLegacyParams + ): Promise>; + + endpoint: Octokit.Endpoint; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team repos`](https://developer.github.com/v3/teams/#list-team-repos) endpoint. + * @deprecated octokit.teams.listRepos() is deprecated, see https://developer.github.com/v3/teams/#list-team-repos-legacy */ listRepos: { (params?: Octokit.RequestOptions & Octokit.TeamsListReposParams): Promise< @@ -35622,16 +41366,39 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; /** - * The "Remove team member" API (described below) is deprecated. + * Lists a team's repositories visible to the authenticated user. * - * We recommend using the [Remove team membership endpoint](https://developer.github.com/v3/teams/members/#remove-team-membership) instead. It allows you to remove both active and pending memberships. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/repos`. + */ + listReposInOrg: { + ( + params?: Octokit.RequestOptions & Octokit.TeamsListReposInOrgParams + ): Promise>; + + endpoint: Octokit.Endpoint; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team repos`](https://developer.github.com/v3/teams/#list-team-repos) endpoint. + * @deprecated octokit.teams.listReposLegacy() is deprecated, see https://developer.github.com/v3/teams/#list-team-repos-legacy + */ + listReposLegacy: { + ( + params?: Octokit.RequestOptions & Octokit.TeamsListReposLegacyParams + ): Promise>; + + endpoint: Octokit.Endpoint; + }; + /** + * The "Remove team member" endpoint (described below) is deprecated. * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/articles/github-s-products) in the GitHub Help documentation. + * We recommend using the [Remove team membership](https://developer.github.com/v3/teams/members/#remove-team-membership) endpoint instead. It allows you to remove both active and pending memberships. + * + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * To remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team. * * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." - * @deprecated octokit.teams.removeMember() is deprecated, see https://developer.github.com/v3/teams/members/#remove-team-member + * @deprecated octokit.teams.removeMember() is deprecated, see https://developer.github.com/v3/teams/members/#remove-team-member-legacy */ removeMember: { ( @@ -35641,11 +41408,33 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; /** - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/articles/github-s-products) in the GitHub Help documentation. + * The "Remove team member" endpoint (described below) is deprecated. + * + * We recommend using the [Remove team membership](https://developer.github.com/v3/teams/members/#remove-team-membership) endpoint instead. It allows you to remove both active and pending memberships. + * + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * To remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team. + * + * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * @deprecated octokit.teams.removeMemberLegacy() is deprecated, see https://developer.github.com/v3/teams/members/#remove-team-member-legacy + */ + removeMemberLegacy: { + ( + params?: Octokit.RequestOptions & Octokit.TeamsRemoveMemberLegacyParams + ): Promise; + + endpoint: Octokit.Endpoint; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Remove team membership`](https://developer.github.com/v3/teams/members/#remove-team-membership) endpoint. + * + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team. * * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * @deprecated octokit.teams.removeMembership() is deprecated, see https://developer.github.com/v3/teams/members/#remove-team-membership-legacy */ removeMembership: { ( @@ -35655,7 +41444,45 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; /** + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team. + * + * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/:org_id/team/:team_id/memberships/:username`. + */ + removeMembershipInOrg: { + ( + params?: Octokit.RequestOptions & + Octokit.TeamsRemoveMembershipInOrgParams + ): Promise; + + endpoint: Octokit.Endpoint; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Remove team membership`](https://developer.github.com/v3/teams/members/#remove-team-membership) endpoint. + * + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team. + * + * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * @deprecated octokit.teams.removeMembershipLegacy() is deprecated, see https://developer.github.com/v3/teams/members/#remove-team-membership-legacy + */ + removeMembershipLegacy: { + ( + params?: Octokit.RequestOptions & + Octokit.TeamsRemoveMembershipLegacyParams + ): Promise; + + endpoint: Octokit.Endpoint; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Remove team project`](https://developer.github.com/v3/teams/#remove-team-project) endpoint. + * * Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it. + * @deprecated octokit.teams.removeProject() is deprecated, see https://developer.github.com/v3/teams/#remove-team-project-legacy */ removeProject: { ( @@ -35665,7 +41492,35 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; /** + * Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/:org_id/team/:team_id/projects/:project_id`. + */ + removeProjectInOrg: { + ( + params?: Octokit.RequestOptions & Octokit.TeamsRemoveProjectInOrgParams + ): Promise; + + endpoint: Octokit.Endpoint; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Remove team project`](https://developer.github.com/v3/teams/#remove-team-project) endpoint. + * + * Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it. + * @deprecated octokit.teams.removeProjectLegacy() is deprecated, see https://developer.github.com/v3/teams/#remove-team-project-legacy + */ + removeProjectLegacy: { + ( + params?: Octokit.RequestOptions & Octokit.TeamsRemoveProjectLegacyParams + ): Promise; + + endpoint: Octokit.Endpoint; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Remove team repository`](https://developer.github.com/v3/teams/#remove-team-repository) endpoint. + * * If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team. + * @deprecated octokit.teams.removeRepo() is deprecated, see https://developer.github.com/v3/teams/#remove-team-repository-legacy */ removeRepo: { ( @@ -35675,7 +41530,35 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; /** - * Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. If you pass the `hellcat-preview` media type, the response will include projects inherited from a parent team. + * If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/:org_id/team/:team_id/repos/:owner/:repo`. + */ + removeRepoInOrg: { + ( + params?: Octokit.RequestOptions & Octokit.TeamsRemoveRepoInOrgParams + ): Promise; + + endpoint: Octokit.Endpoint; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Remove team repository`](https://developer.github.com/v3/teams/#remove-team-repository) endpoint. + * + * If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team. + * @deprecated octokit.teams.removeRepoLegacy() is deprecated, see https://developer.github.com/v3/teams/#remove-team-repository-legacy + */ + removeRepoLegacy: { + ( + params?: Octokit.RequestOptions & Octokit.TeamsRemoveRepoLegacyParams + ): Promise; + + endpoint: Octokit.Endpoint; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Review a team project`](https://developer.github.com/v3/teams/#review-a-team-project) endpoint. + * + * Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. + * @deprecated octokit.teams.reviewProject() is deprecated, see https://developer.github.com/v3/teams/#review-a-team-project-legacy */ reviewProject: { ( @@ -35685,9 +41568,37 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; /** - * To edit a team, the authenticated user must either be an owner of the org that the team is associated with, or a maintainer of the team. + * Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/projects/:project_id`. + */ + reviewProjectInOrg: { + ( + params?: Octokit.RequestOptions & Octokit.TeamsReviewProjectInOrgParams + ): Promise>; + + endpoint: Octokit.Endpoint; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Review a team project`](https://developer.github.com/v3/teams/#review-a-team-project) endpoint. + * + * Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. + * @deprecated octokit.teams.reviewProjectLegacy() is deprecated, see https://developer.github.com/v3/teams/#review-a-team-project-legacy + */ + reviewProjectLegacy: { + ( + params?: Octokit.RequestOptions & Octokit.TeamsReviewProjectLegacyParams + ): Promise>; + + endpoint: Octokit.Endpoint; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Edit team`](https://developer.github.com/v3/teams/#edit-team) endpoint. + * + * To edit a team, the authenticated user must either be an organization owner or a team maintainer. * * **Note:** With nested teams, the `privacy` for parent teams cannot be `secret`. + * @deprecated octokit.teams.update() is deprecated, see https://developer.github.com/v3/teams/#edit-team-legacy */ update: { ( @@ -35701,7 +41612,10 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Edit a discussion`](https://developer.github.com/v3/teams/discussions/#edit-a-discussion) endpoint. + * * Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @deprecated octokit.teams.updateDiscussion() is deprecated, see https://developer.github.com/v3/teams/discussions/#edit-a-discussion-legacy */ updateDiscussion: { ( @@ -35711,7 +41625,10 @@ declare class Octokit { endpoint: Octokit.Endpoint; }; /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Edit a comment`](https://developer.github.com/v3/teams/discussion_comments/#edit-a-comment) endpoint. + * * Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @deprecated octokit.teams.updateDiscussionComment() is deprecated, see https://developer.github.com/v3/teams/discussion_comments/#edit-a-comment-legacy */ updateDiscussionComment: { ( @@ -35721,6 +41638,99 @@ declare class Octokit { Octokit.Response >; + endpoint: Octokit.Endpoint; + }; + /** + * Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number`. + */ + updateDiscussionCommentInOrg: { + ( + params?: Octokit.RequestOptions & + Octokit.TeamsUpdateDiscussionCommentInOrgParams + ): Promise< + Octokit.Response + >; + + endpoint: Octokit.Endpoint; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Edit a comment`](https://developer.github.com/v3/teams/discussion_comments/#edit-a-comment) endpoint. + * + * Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @deprecated octokit.teams.updateDiscussionCommentLegacy() is deprecated, see https://developer.github.com/v3/teams/discussion_comments/#edit-a-comment-legacy + */ + updateDiscussionCommentLegacy: { + ( + params?: Octokit.RequestOptions & + Octokit.TeamsUpdateDiscussionCommentLegacyParams + ): Promise< + Octokit.Response + >; + + endpoint: Octokit.Endpoint; + }; + /** + * Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/:org_id/team/:team_id/discussions/:discussion_number`. + */ + updateDiscussionInOrg: { + ( + params?: Octokit.RequestOptions & + Octokit.TeamsUpdateDiscussionInOrgParams + ): Promise>; + + endpoint: Octokit.Endpoint; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Edit a discussion`](https://developer.github.com/v3/teams/discussions/#edit-a-discussion) endpoint. + * + * Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @deprecated octokit.teams.updateDiscussionLegacy() is deprecated, see https://developer.github.com/v3/teams/discussions/#edit-a-discussion-legacy + */ + updateDiscussionLegacy: { + ( + params?: Octokit.RequestOptions & + Octokit.TeamsUpdateDiscussionLegacyParams + ): Promise>; + + endpoint: Octokit.Endpoint; + }; + /** + * To edit a team, the authenticated user must either be an organization owner or a team maintainer. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/:org_id/team/:team_id`. + */ + updateInOrg: { + ( + params?: Octokit.RequestOptions & + Octokit.TeamsUpdateInOrgParamsDeprecatedPermission + ): Promise>; + ( + params?: Octokit.RequestOptions & Octokit.TeamsUpdateInOrgParams + ): Promise>; + + endpoint: Octokit.Endpoint; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Edit team`](https://developer.github.com/v3/teams/#edit-team) endpoint. + * + * To edit a team, the authenticated user must either be an organization owner or a team maintainer. + * + * **Note:** With nested teams, the `privacy` for parent teams cannot be `secret`. + * @deprecated octokit.teams.updateLegacy() is deprecated, see https://developer.github.com/v3/teams/#edit-team-legacy + */ + updateLegacy: { + ( + params?: Octokit.RequestOptions & + Octokit.TeamsUpdateLegacyParamsDeprecatedPermission + ): Promise>; + ( + params?: Octokit.RequestOptions & Octokit.TeamsUpdateLegacyParams + ): Promise>; + endpoint: Octokit.Endpoint; }; }; @@ -36060,5 +42070,3 @@ declare class Octokit { }; }; } - -export = Octokit; diff --git a/node_modules/@octokit/rest/index.js b/node_modules/@octokit/rest/index.js index 5a228f3..a2d3069 100644 --- a/node_modules/@octokit/rest/index.js +++ b/node_modules/@octokit/rest/index.js @@ -1,15 +1,43 @@ -const Octokit = require("./lib/core"); +const { requestLog } = require("@octokit/plugin-request-log"); +const { + restEndpointMethods +} = require("@octokit/plugin-rest-endpoint-methods"); + +const Core = require("./lib/core"); const CORE_PLUGINS = [ - require("./plugins/log"), - require("./plugins/authentication-deprecated"), // deprecated: remove in v17 require("./plugins/authentication"), + require("./plugins/authentication-deprecated"), // deprecated: remove in v17 + requestLog, require("./plugins/pagination"), - require("./plugins/register-endpoints"), - require("./plugins/rest-api-endpoints"), + restEndpointMethods, require("./plugins/validate"), require("octokit-pagination-methods") // deprecated: remove in v17 ]; -module.exports = Octokit.plugin(CORE_PLUGINS); +const OctokitRest = Core.plugin(CORE_PLUGINS); + +function DeprecatedOctokit(options) { + const warn = + options && options.log && options.log.warn + ? options.log.warn + : console.warn; + warn( + '[@octokit/rest] `const Octokit = require("@octokit/rest")` is deprecated. Use `const { Octokit } = require("@octokit/rest")` instead' + ); + return new OctokitRest(options); +} + +const Octokit = Object.assign(DeprecatedOctokit, { + Octokit: OctokitRest +}); + +Object.keys(OctokitRest).forEach(key => { + /* istanbul ignore else */ + if (OctokitRest.hasOwnProperty(key)) { + Octokit[key] = OctokitRest[key]; + } +}); + +module.exports = Octokit; diff --git a/node_modules/@octokit/rest/node_modules/universal-user-agent/LICENSE.md b/node_modules/@octokit/rest/node_modules/universal-user-agent/LICENSE.md deleted file mode 100644 index f105ab0..0000000 --- a/node_modules/@octokit/rest/node_modules/universal-user-agent/LICENSE.md +++ /dev/null @@ -1,7 +0,0 @@ -# [ISC License](https://spdx.org/licenses/ISC) - -Copyright (c) 2018, Gregor Martynus (https://github.com/gr2m) - -Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies. - -THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. diff --git a/node_modules/@octokit/rest/node_modules/universal-user-agent/README.md b/node_modules/@octokit/rest/node_modules/universal-user-agent/README.md deleted file mode 100644 index d00d14c..0000000 --- a/node_modules/@octokit/rest/node_modules/universal-user-agent/README.md +++ /dev/null @@ -1,25 +0,0 @@ -# universal-user-agent - -> Get a user agent string in both browser and node - -[![@latest](https://img.shields.io/npm/v/universal-user-agent.svg)](https://www.npmjs.com/package/universal-user-agent) -[![Build Status](https://travis-ci.com/gr2m/universal-user-agent.svg?branch=master)](https://travis-ci.com/gr2m/universal-user-agent) -[![Greenkeeper](https://badges.greenkeeper.io/gr2m/universal-user-agent.svg)](https://greenkeeper.io/) - -```js -const { getUserAgent } = require("universal-user-agent"); -// or import { getUserAgent } from "universal-user-agent"; - -const userAgent = getUserAgent(); -// userAgent will look like this -// in browser: "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.13; rv:61.0) Gecko/20100101 Firefox/61.0" -// in node: Node.js/v8.9.4 (macOS High Sierra; x64) -``` - -## Credits - -The Node implementation was originally inspired by [default-user-agent](https://www.npmjs.com/package/default-user-agent). - -## License - -[ISC](LICENSE.md) diff --git a/node_modules/@octokit/rest/node_modules/universal-user-agent/dist-node/index.js b/node_modules/@octokit/rest/node_modules/universal-user-agent/dist-node/index.js deleted file mode 100644 index 80a0710..0000000 --- a/node_modules/@octokit/rest/node_modules/universal-user-agent/dist-node/index.js +++ /dev/null @@ -1,22 +0,0 @@ -'use strict'; - -Object.defineProperty(exports, '__esModule', { value: true }); - -function _interopDefault (ex) { return (ex && (typeof ex === 'object') && 'default' in ex) ? ex['default'] : ex; } - -var osName = _interopDefault(require('os-name')); - -function getUserAgent() { - try { - return `Node.js/${process.version.substr(1)} (${osName()}; ${process.arch})`; - } catch (error) { - if (/wmic os get Caption/.test(error.message)) { - return "Windows "; - } - - throw error; - } -} - -exports.getUserAgent = getUserAgent; -//# sourceMappingURL=index.js.map diff --git a/node_modules/@octokit/rest/node_modules/universal-user-agent/dist-node/index.js.map b/node_modules/@octokit/rest/node_modules/universal-user-agent/dist-node/index.js.map deleted file mode 100644 index aff09ec..0000000 --- a/node_modules/@octokit/rest/node_modules/universal-user-agent/dist-node/index.js.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.js","sources":["../dist-src/node.js"],"sourcesContent":["import osName from \"os-name\";\nexport function getUserAgent() {\n try {\n return `Node.js/${process.version.substr(1)} (${osName()}; ${process.arch})`;\n }\n catch (error) {\n if (/wmic os get Caption/.test(error.message)) {\n return \"Windows \";\n }\n throw error;\n }\n}\n"],"names":["getUserAgent","process","version","substr","osName","arch","error","test","message"],"mappings":";;;;;;;;AACO,SAASA,YAAT,GAAwB;MACvB;WACQ,WAAUC,OAAO,CAACC,OAAR,CAAgBC,MAAhB,CAAuB,CAAvB,CAA0B,KAAIC,MAAM,EAAG,KAAIH,OAAO,CAACI,IAAK,GAA1E;GADJ,CAGA,OAAOC,KAAP,EAAc;QACN,sBAAsBC,IAAtB,CAA2BD,KAAK,CAACE,OAAjC,CAAJ,EAA+C;aACpC,gCAAP;;;UAEEF,KAAN;;;;;;"} \ No newline at end of file diff --git a/node_modules/@octokit/rest/node_modules/universal-user-agent/dist-src/browser.js b/node_modules/@octokit/rest/node_modules/universal-user-agent/dist-src/browser.js deleted file mode 100644 index 6f52232..0000000 --- a/node_modules/@octokit/rest/node_modules/universal-user-agent/dist-src/browser.js +++ /dev/null @@ -1,3 +0,0 @@ -export function getUserAgent() { - return navigator.userAgent; -} diff --git a/node_modules/@octokit/rest/node_modules/universal-user-agent/dist-src/index.js b/node_modules/@octokit/rest/node_modules/universal-user-agent/dist-src/index.js deleted file mode 100644 index c6253f5..0000000 --- a/node_modules/@octokit/rest/node_modules/universal-user-agent/dist-src/index.js +++ /dev/null @@ -1 +0,0 @@ -export { getUserAgent } from "./node"; diff --git a/node_modules/@octokit/rest/node_modules/universal-user-agent/dist-src/node.js b/node_modules/@octokit/rest/node_modules/universal-user-agent/dist-src/node.js deleted file mode 100644 index 8b70a03..0000000 --- a/node_modules/@octokit/rest/node_modules/universal-user-agent/dist-src/node.js +++ /dev/null @@ -1,12 +0,0 @@ -import osName from "os-name"; -export function getUserAgent() { - try { - return `Node.js/${process.version.substr(1)} (${osName()}; ${process.arch})`; - } - catch (error) { - if (/wmic os get Caption/.test(error.message)) { - return "Windows "; - } - throw error; - } -} diff --git a/node_modules/@octokit/rest/node_modules/universal-user-agent/dist-types/browser.d.ts b/node_modules/@octokit/rest/node_modules/universal-user-agent/dist-types/browser.d.ts deleted file mode 100644 index a7bb1c4..0000000 --- a/node_modules/@octokit/rest/node_modules/universal-user-agent/dist-types/browser.d.ts +++ /dev/null @@ -1 +0,0 @@ -export declare function getUserAgent(): string; diff --git a/node_modules/@octokit/rest/node_modules/universal-user-agent/dist-types/index.d.ts b/node_modules/@octokit/rest/node_modules/universal-user-agent/dist-types/index.d.ts deleted file mode 100644 index c6253f5..0000000 --- a/node_modules/@octokit/rest/node_modules/universal-user-agent/dist-types/index.d.ts +++ /dev/null @@ -1 +0,0 @@ -export { getUserAgent } from "./node"; diff --git a/node_modules/@octokit/rest/node_modules/universal-user-agent/dist-types/node.d.ts b/node_modules/@octokit/rest/node_modules/universal-user-agent/dist-types/node.d.ts deleted file mode 100644 index a7bb1c4..0000000 --- a/node_modules/@octokit/rest/node_modules/universal-user-agent/dist-types/node.d.ts +++ /dev/null @@ -1 +0,0 @@ -export declare function getUserAgent(): string; diff --git a/node_modules/@octokit/rest/node_modules/universal-user-agent/dist-web/index.js b/node_modules/@octokit/rest/node_modules/universal-user-agent/dist-web/index.js deleted file mode 100644 index 11ec79b..0000000 --- a/node_modules/@octokit/rest/node_modules/universal-user-agent/dist-web/index.js +++ /dev/null @@ -1,6 +0,0 @@ -function getUserAgent() { - return navigator.userAgent; -} - -export { getUserAgent }; -//# sourceMappingURL=index.js.map diff --git a/node_modules/@octokit/rest/node_modules/universal-user-agent/dist-web/index.js.map b/node_modules/@octokit/rest/node_modules/universal-user-agent/dist-web/index.js.map deleted file mode 100644 index 549407e..0000000 --- a/node_modules/@octokit/rest/node_modules/universal-user-agent/dist-web/index.js.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.js","sources":["../dist-src/browser.js"],"sourcesContent":["export function getUserAgent() {\n return navigator.userAgent;\n}\n"],"names":[],"mappings":"AAAO,SAAS,YAAY,GAAG;IAC3B,OAAO,SAAS,CAAC,SAAS,CAAC;CAC9B;;;;"} \ No newline at end of file diff --git a/node_modules/@octokit/rest/node_modules/universal-user-agent/package.json b/node_modules/@octokit/rest/node_modules/universal-user-agent/package.json deleted file mode 100644 index 1999e09..0000000 --- a/node_modules/@octokit/rest/node_modules/universal-user-agent/package.json +++ /dev/null @@ -1,65 +0,0 @@ -{ - "_from": "universal-user-agent@^4.0.0", - "_id": "universal-user-agent@4.0.0", - "_inBundle": false, - "_integrity": "sha512-eM8knLpev67iBDizr/YtqkJsF3GK8gzDc6st/WKzrTuPtcsOKW/0IdL4cnMBsU69pOx0otavLWBDGTwg+dB0aA==", - "_location": "/@octokit/rest/universal-user-agent", - "_phantomChildren": {}, - "_requested": { - "type": "range", - "registry": true, - "raw": "universal-user-agent@^4.0.0", - "name": "universal-user-agent", - "escapedName": "universal-user-agent", - "rawSpec": "^4.0.0", - "saveSpec": null, - "fetchSpec": "^4.0.0" - }, - "_requiredBy": [ - "/@octokit/rest" - ], - "_resolved": "https://registry.npmjs.org/universal-user-agent/-/universal-user-agent-4.0.0.tgz", - "_shasum": "27da2ec87e32769619f68a14996465ea1cb9df16", - "_spec": "universal-user-agent@^4.0.0", - "_where": "/Users/shim.taewon/Documents/sticky-pull-request-comment/node_modules/@octokit/rest", - "bugs": { - "url": "https://github.com/gr2m/universal-user-agent/issues" - }, - "bundleDependencies": false, - "dependencies": { - "os-name": "^3.1.0" - }, - "deprecated": false, - "description": "Get a user agent string in both browser and node", - "devDependencies": { - "@gr2m/pika-plugin-build-web": "^0.6.0-issue-84.1", - "@pika/pack": "^0.5.0", - "@pika/plugin-build-node": "^0.6.0", - "@pika/plugin-ts-standard-pkg": "^0.6.0", - "@types/jest": "^24.0.18", - "jest": "^24.9.0", - "prettier": "^1.18.2", - "semantic-release": "^15.9.15", - "ts-jest": "^24.0.2", - "typescript": "^3.6.2" - }, - "files": [ - "dist-*/", - "bin/" - ], - "homepage": "https://github.com/gr2m/universal-user-agent#readme", - "keywords": [], - "license": "ISC", - "main": "dist-node/index.js", - "module": "dist-web/index.js", - "name": "universal-user-agent", - "pika": true, - "repository": { - "type": "git", - "url": "git+https://github.com/gr2m/universal-user-agent.git" - }, - "sideEffects": false, - "source": "dist-src/index.js", - "types": "dist-types/index.d.ts", - "version": "4.0.0" -} diff --git a/node_modules/@octokit/rest/package.json b/node_modules/@octokit/rest/package.json index ab175f7..21ed3d8 100644 --- a/node_modules/@octokit/rest/package.json +++ b/node_modules/@octokit/rest/package.json @@ -1,30 +1,37 @@ { - "_from": "@octokit/rest@^16.15.0", - "_id": "@octokit/rest@16.35.0", + "_args": [ + [ + "@octokit/rest@16.43.1", + "/Users/marocchino/Documents/sticky-pull-request-comment" + ] + ], + "_from": "@octokit/rest@16.43.1", + "_id": "@octokit/rest@16.43.1", "_inBundle": false, - "_integrity": "sha512-9ShFqYWo0CLoGYhA1FdtdykJuMzS/9H6vSbbQWDX4pWr4p9v+15MsH/wpd/3fIU+tSxylaNO48+PIHqOkBRx3w==", + "_integrity": "sha512-gfFKwRT/wFxq5qlNjnW2dh+qh74XgTQ2B179UX5K1HYCluioWj8Ndbgqw2PVqa1NnVJkGHp2ovMpVn/DImlmkw==", "_location": "/@octokit/rest", "_phantomChildren": { - "os-name": "3.1.0" + "@octokit/types": "2.14.0", + "deprecation": "2.3.1", + "once": "1.4.0" }, "_requested": { - "type": "range", + "type": "version", "registry": true, - "raw": "@octokit/rest@^16.15.0", + "raw": "@octokit/rest@16.43.1", "name": "@octokit/rest", "escapedName": "@octokit%2frest", "scope": "@octokit", - "rawSpec": "^16.15.0", + "rawSpec": "16.43.1", "saveSpec": null, - "fetchSpec": "^16.15.0" + "fetchSpec": "16.43.1" }, "_requiredBy": [ "/@actions/github" ], - "_resolved": "https://registry.npmjs.org/@octokit/rest/-/rest-16.35.0.tgz", - "_shasum": "7ccc1f802f407d5b8eb21768c6deca44e7b4c0d8", - "_spec": "@octokit/rest@^16.15.0", - "_where": "/Users/shim.taewon/Documents/sticky-pull-request-comment/node_modules/@actions/github", + "_resolved": "https://registry.npmjs.org/@octokit/rest/-/rest-16.43.1.tgz", + "_spec": "16.43.1", + "_where": "/Users/marocchino/Documents/sticky-pull-request-comment", "author": { "name": "Gregor Martynus", "url": "https://github.com/gr2m" @@ -32,7 +39,6 @@ "bugs": { "url": "https://github.com/octokit/rest.js/issues" }, - "bundleDependencies": false, "bundlesize": [ { "path": "./dist/octokit-rest.min.js.gz", @@ -58,6 +64,10 @@ } ], "dependencies": { + "@octokit/auth-token": "^2.4.0", + "@octokit/plugin-paginate-rest": "^1.1.1", + "@octokit/plugin-request-log": "^1.0.0", + "@octokit/plugin-rest-endpoint-methods": "2.4.0", "@octokit/request": "^5.2.0", "@octokit/request-error": "^1.0.2", "atob-lite": "^2.0.0", @@ -71,32 +81,33 @@ "once": "^1.4.0", "universal-user-agent": "^4.0.0" }, - "deprecated": false, "description": "GitHub REST API client for Node.js", "devDependencies": { "@gimenete/type-writer": "^0.1.3", + "@octokit/auth": "^1.1.1", "@octokit/fixtures-server": "^5.0.6", "@octokit/graphql": "^4.2.0", - "@types/node": "^12.0.0", + "@types/node": "^13.1.0", "bundlesize": "^0.18.0", "chai": "^4.1.2", - "compression-webpack-plugin": "^3.0.0", + "compression-webpack-plugin": "^3.1.0", "cypress": "^3.0.0", "glob": "^7.1.2", - "http-proxy-agent": "^2.1.0", + "http-proxy-agent": "^4.0.0", "lodash.camelcase": "^4.3.0", "lodash.merge": "^4.6.1", "lodash.upperfirst": "^4.3.1", - "mkdirp": "^0.5.1", - "mocha": "^6.0.0", - "mustache": "^3.0.0", + "lolex": "^5.1.2", + "mkdirp": "^1.0.0", + "mocha": "^7.0.1", + "mustache": "^4.0.0", "nock": "^11.3.3", "npm-run-all": "^4.1.2", - "nyc": "^14.0.0", + "nyc": "^15.0.0", "prettier": "^1.14.2", "proxy": "^1.0.0", - "semantic-release": "^15.0.0", - "sinon": "^7.2.4", + "semantic-release": "^17.0.0", + "sinon": "^8.0.0", "sinon-chai": "^3.0.0", "sort-keys": "^4.0.0", "string-to-arraybuffer": "^1.0.0", @@ -163,11 +174,10 @@ "test": "nyc mocha test/mocha-node-setup.js \"test/*/**/*-test.js\"", "test:browser": "cypress run --browser chrome", "update-endpoints": "npm-run-all update-endpoints:*", - "update-endpoints:code": "node scripts/update-endpoints/code", "update-endpoints:fetch-json": "node scripts/update-endpoints/fetch-json", "update-endpoints:typescript": "node scripts/update-endpoints/typescript", "validate:ts": "tsc --target es6 --noImplicitAny index.d.ts" }, "types": "index.d.ts", - "version": "16.35.0" + "version": "16.43.1" } diff --git a/node_modules/@octokit/rest/plugins/authentication/before-request.js b/node_modules/@octokit/rest/plugins/authentication/before-request.js index c18df95..aae5daa 100644 --- a/node_modules/@octokit/rest/plugins/authentication/before-request.js +++ b/node_modules/@octokit/rest/plugins/authentication/before-request.js @@ -7,18 +7,6 @@ const withAuthorizationPrefix = require("./with-authorization-prefix"); function authenticationBeforeRequest(state, options) { if (typeof state.auth === "string") { options.headers.authorization = withAuthorizationPrefix(state.auth); - - // https://developer.github.com/v3/previews/#integrations - if ( - /^bearer /i.test(state.auth) && - !/machine-man/.test(options.headers.accept) - ) { - const acceptHeaders = options.headers.accept - .split(",") - .concat("application/vnd.github.machine-man-preview+json"); - options.headers.accept = acceptHeaders.filter(Boolean).join(","); - } - return; } diff --git a/node_modules/@octokit/rest/plugins/authentication/index.js b/node_modules/@octokit/rest/plugins/authentication/index.js index 6a51d42..6dcb859 100644 --- a/node_modules/@octokit/rest/plugins/authentication/index.js +++ b/node_modules/@octokit/rest/plugins/authentication/index.js @@ -1,14 +1,69 @@ module.exports = authenticationPlugin; +const { createTokenAuth } = require("@octokit/auth-token"); +const { Deprecation } = require("deprecation"); +const once = require("once"); + const beforeRequest = require("./before-request"); const requestError = require("./request-error"); const validate = require("./validate"); +const withAuthorizationPrefix = require("./with-authorization-prefix"); + +const deprecateAuthBasic = once((log, deprecation) => log.warn(deprecation)); +const deprecateAuthObject = once((log, deprecation) => log.warn(deprecation)); function authenticationPlugin(octokit, options) { - if (!options.auth) { + // If `options.authStrategy` is set then use it and pass in `options.auth` + if (options.authStrategy) { + const auth = options.authStrategy(options.auth); + octokit.hook.wrap("request", auth.hook); + octokit.auth = auth; return; } + // If neither `options.authStrategy` nor `options.auth` are set, the `octokit` instance + // is unauthenticated. The `octokit.auth()` method is a no-op and no request hook is registred. + if (!options.auth) { + octokit.auth = () => + Promise.resolve({ + type: "unauthenticated" + }); + return; + } + + const isBasicAuthString = + typeof options.auth === "string" && + /^basic/.test(withAuthorizationPrefix(options.auth)); + + // If only `options.auth` is set to a string, use the default token authentication strategy. + if (typeof options.auth === "string" && !isBasicAuthString) { + const auth = createTokenAuth(options.auth); + octokit.hook.wrap("request", auth.hook); + octokit.auth = auth; + return; + } + + // Otherwise log a deprecation message + const [deprecationMethod, deprecationMessapge] = isBasicAuthString + ? [ + deprecateAuthBasic, + 'Setting the "new Octokit({ auth })" option to a Basic Auth string is deprecated. Use https://github.com/octokit/auth-basic.js instead. See (https://octokit.github.io/rest.js/#authentication)' + ] + : [ + deprecateAuthObject, + 'Setting the "new Octokit({ auth })" option to an object without also setting the "authStrategy" option is deprecated and will be removed in v17. See (https://octokit.github.io/rest.js/#authentication)' + ]; + deprecationMethod( + octokit.log, + new Deprecation("[@octokit/rest] " + deprecationMessapge) + ); + + octokit.auth = () => + Promise.resolve({ + type: "deprecated", + message: deprecationMessapge + }); + validate(options.auth); const state = { diff --git a/node_modules/@octokit/rest/plugins/log/index.js b/node_modules/@octokit/rest/plugins/log/index.js deleted file mode 100644 index fed446a..0000000 --- a/node_modules/@octokit/rest/plugins/log/index.js +++ /dev/null @@ -1,28 +0,0 @@ -module.exports = octokitDebug; - -function octokitDebug(octokit) { - octokit.hook.wrap("request", (request, options) => { - octokit.log.debug("request", options); - const start = Date.now(); - const requestOptions = octokit.request.endpoint.parse(options); - const path = requestOptions.url.replace(options.baseUrl, ""); - - return request(options) - .then(response => { - octokit.log.info( - `${requestOptions.method} ${path} - ${ - response.status - } in ${Date.now() - start}ms` - ); - return response; - }) - - .catch(error => { - octokit.log.info( - `${requestOptions.method} ${path} - ${error.status} in ${Date.now() - - start}ms` - ); - throw error; - }); - }); -} diff --git a/node_modules/@octokit/rest/plugins/pagination/index.js b/node_modules/@octokit/rest/plugins/pagination/index.js index e7673bc..f5a3f7b 100644 --- a/node_modules/@octokit/rest/plugins/pagination/index.js +++ b/node_modules/@octokit/rest/plugins/pagination/index.js @@ -1,9 +1,7 @@ module.exports = paginatePlugin; -const iterator = require("./iterator"); -const paginate = require("./paginate"); +const { paginateRest } = require("@octokit/plugin-paginate-rest"); function paginatePlugin(octokit) { - octokit.paginate = paginate.bind(null, octokit); - octokit.paginate.iterator = iterator.bind(null, octokit); + Object.assign(octokit, paginateRest(octokit)); } diff --git a/node_modules/@octokit/rest/plugins/pagination/iterator.js b/node_modules/@octokit/rest/plugins/pagination/iterator.js deleted file mode 100644 index 00ea8eb..0000000 --- a/node_modules/@octokit/rest/plugins/pagination/iterator.js +++ /dev/null @@ -1,34 +0,0 @@ -module.exports = iterator; - -const normalizePaginatedListResponse = require("./normalize-paginated-list-response"); - -function iterator(octokit, options) { - const headers = options.headers; - let url = octokit.request.endpoint(options).url; - - return { - [Symbol.asyncIterator]: () => ({ - next() { - if (!url) { - return Promise.resolve({ done: true }); - } - - return octokit - .request({ url, headers }) - - .then(response => { - normalizePaginatedListResponse(octokit, url, response); - - // `response.headers.link` format: - // '; rel="next", ; rel="last"' - // sets `url` to undefined if "next" URL is not present or `link` header is not set - url = ((response.headers.link || "").match( - /<([^>]+)>;\s*rel="next"/ - ) || [])[1]; - - return { value: response }; - }); - } - }) - }; -} diff --git a/node_modules/@octokit/rest/plugins/pagination/normalize-paginated-list-response.js b/node_modules/@octokit/rest/plugins/pagination/normalize-paginated-list-response.js deleted file mode 100644 index e664142..0000000 --- a/node_modules/@octokit/rest/plugins/pagination/normalize-paginated-list-response.js +++ /dev/null @@ -1,116 +0,0 @@ -/** - * Some “list” response that can be paginated have a different response structure - * - * They have a `total_count` key in the response (search also has `incomplete_results`, - * /installation/repositories also has `repository_selection`), as well as a key with - * the list of the items which name varies from endpoint to endpoint: - * - * - https://developer.github.com/v3/search/#example (key `items`) - * - https://developer.github.com/v3/checks/runs/#response-3 (key: `check_runs`) - * - https://developer.github.com/v3/checks/suites/#response-1 (key: `check_suites`) - * - https://developer.github.com/v3/apps/installations/#list-repositories (key: `repositories`) - * - https://developer.github.com/v3/apps/installations/#list-installations-for-a-user (key `installations`) - * - https://developer.github.com/v3/orgs/#list-installations-for-an-organization (key `installations`) - * - * Octokit normalizes these responses so that paginated results are always returned following - * the same structure. One challenge is that if the list response has only one page, no Link - * header is provided, so this header alone is not sufficient to check wether a response is - * paginated or not. For the exceptions with the namespace, a fallback check for the route - * paths has to be added in order to normalize the response. We cannot check for the total_count - * property because it also exists in the response of Get the combined status for a specific ref. - */ - -module.exports = normalizePaginatedListResponse; - -const { Deprecation } = require("deprecation"); -const once = require("once"); - -const deprecateIncompleteResults = once((log, deprecation) => - log.warn(deprecation) -); -const deprecateTotalCount = once((log, deprecation) => log.warn(deprecation)); -const deprecateNamespace = once((log, deprecation) => log.warn(deprecation)); - -const REGEX_IS_SEARCH_PATH = /^\/search\//; -const REGEX_IS_CHECKS_PATH = /^\/repos\/[^/]+\/[^/]+\/commits\/[^/]+\/(check-runs|check-suites)/; -const REGEX_IS_INSTALLATION_REPOSITORIES_PATH = /^\/installation\/repositories/; -const REGEX_IS_USER_INSTALLATIONS_PATH = /^\/user\/installations/; -const REGEX_IS_ORG_INSTALLATIONS_PATH = /^\/orgs\/[^/]+\/installations/; - -function normalizePaginatedListResponse(octokit, url, response) { - const path = url.replace(octokit.request.endpoint.DEFAULTS.baseUrl, ""); - if ( - !REGEX_IS_SEARCH_PATH.test(path) && - !REGEX_IS_CHECKS_PATH.test(path) && - !REGEX_IS_INSTALLATION_REPOSITORIES_PATH.test(path) && - !REGEX_IS_USER_INSTALLATIONS_PATH.test(path) && - !REGEX_IS_ORG_INSTALLATIONS_PATH.test(path) - ) { - return; - } - - // keep the additional properties intact to avoid a breaking change, - // but log a deprecation warning when accessed - const incompleteResults = response.data.incomplete_results; - const repositorySelection = response.data.repository_selection; - const totalCount = response.data.total_count; - delete response.data.incomplete_results; - delete response.data.repository_selection; - delete response.data.total_count; - - const namespaceKey = Object.keys(response.data)[0]; - - response.data = response.data[namespaceKey]; - - Object.defineProperty(response.data, namespaceKey, { - get() { - deprecateNamespace( - octokit.log, - new Deprecation( - `[@octokit/rest] "result.data.${namespaceKey}" is deprecated. Use "result.data" instead` - ) - ); - return response.data; - } - }); - - if (typeof incompleteResults !== "undefined") { - Object.defineProperty(response.data, "incomplete_results", { - get() { - deprecateIncompleteResults( - octokit.log, - new Deprecation( - '[@octokit/rest] "result.data.incomplete_results" is deprecated.' - ) - ); - return incompleteResults; - } - }); - } - - if (typeof repositorySelection !== "undefined") { - Object.defineProperty(response.data, "repository_selection", { - get() { - deprecateTotalCount( - octokit.log, - new Deprecation( - '[@octokit/rest] "result.data.repository_selection" is deprecated.' - ) - ); - return repositorySelection; - } - }); - } - - Object.defineProperty(response.data, "total_count", { - get() { - deprecateTotalCount( - octokit.log, - new Deprecation( - '[@octokit/rest] "result.data.total_count" is deprecated.' - ) - ); - return totalCount; - } - }); -} diff --git a/node_modules/@octokit/rest/plugins/pagination/paginate.js b/node_modules/@octokit/rest/plugins/pagination/paginate.js deleted file mode 100644 index db4752b..0000000 --- a/node_modules/@octokit/rest/plugins/pagination/paginate.js +++ /dev/null @@ -1,40 +0,0 @@ -module.exports = paginate; - -const iterator = require("./iterator"); - -function paginate(octokit, route, options, mapFn) { - if (typeof options === "function") { - mapFn = options; - options = undefined; - } - options = octokit.request.endpoint.merge(route, options); - return gather( - octokit, - [], - iterator(octokit, options)[Symbol.asyncIterator](), - mapFn - ); -} - -function gather(octokit, results, iterator, mapFn) { - return iterator.next().then(result => { - if (result.done) { - return results; - } - - let earlyExit = false; - function done() { - earlyExit = true; - } - - results = results.concat( - mapFn ? mapFn(result.value, done) : result.value.data - ); - - if (earlyExit) { - return results; - } - - return gather(octokit, results, iterator, mapFn); - }); -} diff --git a/node_modules/@octokit/rest/plugins/register-endpoints/index.js b/node_modules/@octokit/rest/plugins/register-endpoints/index.js deleted file mode 100644 index 8b92538..0000000 --- a/node_modules/@octokit/rest/plugins/register-endpoints/index.js +++ /dev/null @@ -1,7 +0,0 @@ -module.exports = octokitRegisterEndpoints; - -const registerEndpoints = require("./register-endpoints"); - -function octokitRegisterEndpoints(octokit) { - octokit.registerEndpoints = registerEndpoints.bind(null, octokit); -} diff --git a/node_modules/@octokit/rest/plugins/register-endpoints/register-endpoints.js b/node_modules/@octokit/rest/plugins/register-endpoints/register-endpoints.js deleted file mode 100644 index 0ffd784..0000000 --- a/node_modules/@octokit/rest/plugins/register-endpoints/register-endpoints.js +++ /dev/null @@ -1,98 +0,0 @@ -module.exports = registerEndpoints; - -const { Deprecation } = require("deprecation"); - -function registerEndpoints(octokit, routes) { - Object.keys(routes).forEach(namespaceName => { - if (!octokit[namespaceName]) { - octokit[namespaceName] = {}; - } - - Object.keys(routes[namespaceName]).forEach(apiName => { - const apiOptions = routes[namespaceName][apiName]; - - const endpointDefaults = ["method", "url", "headers"].reduce( - (map, key) => { - if (typeof apiOptions[key] !== "undefined") { - map[key] = apiOptions[key]; - } - - return map; - }, - {} - ); - - endpointDefaults.request = { - validate: apiOptions.params - }; - - let request = octokit.request.defaults(endpointDefaults); - - // patch request & endpoint methods to support deprecated parameters. - // Not the most elegant solution, but we don’t want to move deprecation - // logic into octokit/endpoint.js as it’s out of scope - const hasDeprecatedParam = Object.keys(apiOptions.params || {}).find( - key => apiOptions.params[key].deprecated - ); - if (hasDeprecatedParam) { - const patch = patchForDeprecation.bind(null, octokit, apiOptions); - request = patch( - octokit.request.defaults(endpointDefaults), - `.${namespaceName}.${apiName}()` - ); - request.endpoint = patch( - request.endpoint, - `.${namespaceName}.${apiName}.endpoint()` - ); - request.endpoint.merge = patch( - request.endpoint.merge, - `.${namespaceName}.${apiName}.endpoint.merge()` - ); - } - - if (apiOptions.deprecated) { - octokit[namespaceName][apiName] = function deprecatedEndpointMethod() { - octokit.log.warn( - new Deprecation(`[@octokit/rest] ${apiOptions.deprecated}`) - ); - octokit[namespaceName][apiName] = request; - return request.apply(null, arguments); - }; - - return; - } - - octokit[namespaceName][apiName] = request; - }); - }); -} - -function patchForDeprecation(octokit, apiOptions, method, methodName) { - const patchedMethod = options => { - options = Object.assign({}, options); - - Object.keys(options).forEach(key => { - if (apiOptions.params[key] && apiOptions.params[key].deprecated) { - const aliasKey = apiOptions.params[key].alias; - - octokit.log.warn( - new Deprecation( - `[@octokit/rest] "${key}" parameter is deprecated for "${methodName}". Use "${aliasKey}" instead` - ) - ); - - if (!(aliasKey in options)) { - options[aliasKey] = options[key]; - } - delete options[key]; - } - }); - - return method(options); - }; - Object.keys(method).forEach(key => { - patchedMethod[key] = method[key]; - }); - - return patchedMethod; -} diff --git a/node_modules/@octokit/rest/plugins/rest-api-endpoints/index.js b/node_modules/@octokit/rest/plugins/rest-api-endpoints/index.js deleted file mode 100644 index 4835cee..0000000 --- a/node_modules/@octokit/rest/plugins/rest-api-endpoints/index.js +++ /dev/null @@ -1,13 +0,0 @@ -module.exports = octokitRestApiEndpoints; - -const ROUTES = require("./routes.json"); - -function octokitRestApiEndpoints(octokit) { - // Aliasing scopes for backward compatibility - // See https://github.com/octokit/rest.js/pull/1134 - ROUTES.gitdata = ROUTES.git; - ROUTES.authorization = ROUTES.oauthAuthorizations; - ROUTES.pullRequests = ROUTES.pulls; - - octokit.registerEndpoints(ROUTES); -} diff --git a/node_modules/@octokit/rest/plugins/rest-api-endpoints/routes.json b/node_modules/@octokit/rest/plugins/rest-api-endpoints/routes.json deleted file mode 100644 index 31e3fca..0000000 --- a/node_modules/@octokit/rest/plugins/rest-api-endpoints/routes.json +++ /dev/null @@ -1,5927 +0,0 @@ -{ - "activity": { - "checkStarringRepo": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/user/starred/:owner/:repo" - }, - "deleteRepoSubscription": { - "method": "DELETE", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/subscription" - }, - "deleteThreadSubscription": { - "method": "DELETE", - "params": { "thread_id": { "required": true, "type": "integer" } }, - "url": "/notifications/threads/:thread_id/subscription" - }, - "getRepoSubscription": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/subscription" - }, - "getThread": { - "method": "GET", - "params": { "thread_id": { "required": true, "type": "integer" } }, - "url": "/notifications/threads/:thread_id" - }, - "getThreadSubscription": { - "method": "GET", - "params": { "thread_id": { "required": true, "type": "integer" } }, - "url": "/notifications/threads/:thread_id/subscription" - }, - "listEventsForOrg": { - "method": "GET", - "params": { - "org": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "username": { "required": true, "type": "string" } - }, - "url": "/users/:username/events/orgs/:org" - }, - "listEventsForUser": { - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "username": { "required": true, "type": "string" } - }, - "url": "/users/:username/events" - }, - "listFeeds": { "method": "GET", "params": {}, "url": "/feeds" }, - "listNotifications": { - "method": "GET", - "params": { - "all": { "type": "boolean" }, - "before": { "type": "string" }, - "page": { "type": "integer" }, - "participating": { "type": "boolean" }, - "per_page": { "type": "integer" }, - "since": { "type": "string" } - }, - "url": "/notifications" - }, - "listNotificationsForRepo": { - "method": "GET", - "params": { - "all": { "type": "boolean" }, - "before": { "type": "string" }, - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "participating": { "type": "boolean" }, - "per_page": { "type": "integer" }, - "repo": { "required": true, "type": "string" }, - "since": { "type": "string" } - }, - "url": "/repos/:owner/:repo/notifications" - }, - "listPublicEvents": { - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" } - }, - "url": "/events" - }, - "listPublicEventsForOrg": { - "method": "GET", - "params": { - "org": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" } - }, - "url": "/orgs/:org/events" - }, - "listPublicEventsForRepoNetwork": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/networks/:owner/:repo/events" - }, - "listPublicEventsForUser": { - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "username": { "required": true, "type": "string" } - }, - "url": "/users/:username/events/public" - }, - "listReceivedEventsForUser": { - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "username": { "required": true, "type": "string" } - }, - "url": "/users/:username/received_events" - }, - "listReceivedPublicEventsForUser": { - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "username": { "required": true, "type": "string" } - }, - "url": "/users/:username/received_events/public" - }, - "listRepoEvents": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/events" - }, - "listReposStarredByAuthenticatedUser": { - "method": "GET", - "params": { - "direction": { "enum": ["asc", "desc"], "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "sort": { "enum": ["created", "updated"], "type": "string" } - }, - "url": "/user/starred" - }, - "listReposStarredByUser": { - "method": "GET", - "params": { - "direction": { "enum": ["asc", "desc"], "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "sort": { "enum": ["created", "updated"], "type": "string" }, - "username": { "required": true, "type": "string" } - }, - "url": "/users/:username/starred" - }, - "listReposWatchedByUser": { - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "username": { "required": true, "type": "string" } - }, - "url": "/users/:username/subscriptions" - }, - "listStargazersForRepo": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/stargazers" - }, - "listWatchedReposForAuthenticatedUser": { - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" } - }, - "url": "/user/subscriptions" - }, - "listWatchersForRepo": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/subscribers" - }, - "markAsRead": { - "method": "PUT", - "params": { "last_read_at": { "type": "string" } }, - "url": "/notifications" - }, - "markNotificationsAsReadForRepo": { - "method": "PUT", - "params": { - "last_read_at": { "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/notifications" - }, - "markThreadAsRead": { - "method": "PATCH", - "params": { "thread_id": { "required": true, "type": "integer" } }, - "url": "/notifications/threads/:thread_id" - }, - "setRepoSubscription": { - "method": "PUT", - "params": { - "ignored": { "type": "boolean" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "subscribed": { "type": "boolean" } - }, - "url": "/repos/:owner/:repo/subscription" - }, - "setThreadSubscription": { - "method": "PUT", - "params": { - "ignored": { "type": "boolean" }, - "thread_id": { "required": true, "type": "integer" } - }, - "url": "/notifications/threads/:thread_id/subscription" - }, - "starRepo": { - "method": "PUT", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/user/starred/:owner/:repo" - }, - "unstarRepo": { - "method": "DELETE", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/user/starred/:owner/:repo" - } - }, - "apps": { - "addRepoToInstallation": { - "headers": { - "accept": "application/vnd.github.machine-man-preview+json" - }, - "method": "PUT", - "params": { - "installation_id": { "required": true, "type": "integer" }, - "repository_id": { "required": true, "type": "integer" } - }, - "url": "/user/installations/:installation_id/repositories/:repository_id" - }, - "checkAccountIsAssociatedWithAny": { - "method": "GET", - "params": { - "account_id": { "required": true, "type": "integer" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" } - }, - "url": "/marketplace_listing/accounts/:account_id" - }, - "checkAccountIsAssociatedWithAnyStubbed": { - "method": "GET", - "params": { - "account_id": { "required": true, "type": "integer" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" } - }, - "url": "/marketplace_listing/stubbed/accounts/:account_id" - }, - "checkAuthorization": { - "deprecated": "octokit.oauthAuthorizations.checkAuthorization() has been renamed to octokit.apps.checkAuthorization() (2019-11-05)", - "method": "GET", - "params": { - "access_token": { "required": true, "type": "string" }, - "client_id": { "required": true, "type": "string" } - }, - "url": "/applications/:client_id/tokens/:access_token" - }, - "checkToken": { - "headers": { - "accept": "application/vnd.github.doctor-strange-preview+json" - }, - "method": "POST", - "params": { - "access_token": { "type": "string" }, - "client_id": { "required": true, "type": "string" } - }, - "url": "/applications/:client_id/token" - }, - "createContentAttachment": { - "headers": { "accept": "application/vnd.github.corsair-preview+json" }, - "method": "POST", - "params": { - "body": { "required": true, "type": "string" }, - "content_reference_id": { "required": true, "type": "integer" }, - "title": { "required": true, "type": "string" } - }, - "url": "/content_references/:content_reference_id/attachments" - }, - "createFromManifest": { - "headers": { "accept": "application/vnd.github.fury-preview+json" }, - "method": "POST", - "params": { "code": { "required": true, "type": "string" } }, - "url": "/app-manifests/:code/conversions" - }, - "createInstallationToken": { - "headers": { - "accept": "application/vnd.github.machine-man-preview+json" - }, - "method": "POST", - "params": { - "installation_id": { "required": true, "type": "integer" }, - "permissions": { "type": "object" }, - "repository_ids": { "type": "integer[]" } - }, - "url": "/app/installations/:installation_id/access_tokens" - }, - "deleteAuthorization": { - "headers": { - "accept": "application/vnd.github.doctor-strange-preview+json" - }, - "method": "DELETE", - "params": { - "access_token": { "type": "string" }, - "client_id": { "required": true, "type": "string" } - }, - "url": "/applications/:client_id/grant" - }, - "deleteInstallation": { - "headers": { - "accept": "application/vnd.github.gambit-preview+json,application/vnd.github.machine-man-preview+json" - }, - "method": "DELETE", - "params": { "installation_id": { "required": true, "type": "integer" } }, - "url": "/app/installations/:installation_id" - }, - "deleteToken": { - "headers": { - "accept": "application/vnd.github.doctor-strange-preview+json" - }, - "method": "DELETE", - "params": { - "access_token": { "type": "string" }, - "client_id": { "required": true, "type": "string" } - }, - "url": "/applications/:client_id/token" - }, - "findOrgInstallation": { - "deprecated": "octokit.apps.findOrgInstallation() has been renamed to octokit.apps.getOrgInstallation() (2019-04-10)", - "headers": { - "accept": "application/vnd.github.machine-man-preview+json" - }, - "method": "GET", - "params": { "org": { "required": true, "type": "string" } }, - "url": "/orgs/:org/installation" - }, - "findRepoInstallation": { - "deprecated": "octokit.apps.findRepoInstallation() has been renamed to octokit.apps.getRepoInstallation() (2019-04-10)", - "headers": { - "accept": "application/vnd.github.machine-man-preview+json" - }, - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/installation" - }, - "findUserInstallation": { - "deprecated": "octokit.apps.findUserInstallation() has been renamed to octokit.apps.getUserInstallation() (2019-04-10)", - "headers": { - "accept": "application/vnd.github.machine-man-preview+json" - }, - "method": "GET", - "params": { "username": { "required": true, "type": "string" } }, - "url": "/users/:username/installation" - }, - "getAuthenticated": { - "headers": { - "accept": "application/vnd.github.machine-man-preview+json" - }, - "method": "GET", - "params": {}, - "url": "/app" - }, - "getBySlug": { - "headers": { - "accept": "application/vnd.github.machine-man-preview+json" - }, - "method": "GET", - "params": { "app_slug": { "required": true, "type": "string" } }, - "url": "/apps/:app_slug" - }, - "getInstallation": { - "headers": { - "accept": "application/vnd.github.machine-man-preview+json" - }, - "method": "GET", - "params": { "installation_id": { "required": true, "type": "integer" } }, - "url": "/app/installations/:installation_id" - }, - "getOrgInstallation": { - "headers": { - "accept": "application/vnd.github.machine-man-preview+json" - }, - "method": "GET", - "params": { "org": { "required": true, "type": "string" } }, - "url": "/orgs/:org/installation" - }, - "getRepoInstallation": { - "headers": { - "accept": "application/vnd.github.machine-man-preview+json" - }, - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/installation" - }, - "getUserInstallation": { - "headers": { - "accept": "application/vnd.github.machine-man-preview+json" - }, - "method": "GET", - "params": { "username": { "required": true, "type": "string" } }, - "url": "/users/:username/installation" - }, - "listAccountsUserOrOrgOnPlan": { - "method": "GET", - "params": { - "direction": { "enum": ["asc", "desc"], "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "plan_id": { "required": true, "type": "integer" }, - "sort": { "enum": ["created", "updated"], "type": "string" } - }, - "url": "/marketplace_listing/plans/:plan_id/accounts" - }, - "listAccountsUserOrOrgOnPlanStubbed": { - "method": "GET", - "params": { - "direction": { "enum": ["asc", "desc"], "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "plan_id": { "required": true, "type": "integer" }, - "sort": { "enum": ["created", "updated"], "type": "string" } - }, - "url": "/marketplace_listing/stubbed/plans/:plan_id/accounts" - }, - "listInstallationReposForAuthenticatedUser": { - "headers": { - "accept": "application/vnd.github.machine-man-preview+json" - }, - "method": "GET", - "params": { - "installation_id": { "required": true, "type": "integer" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" } - }, - "url": "/user/installations/:installation_id/repositories" - }, - "listInstallations": { - "headers": { - "accept": "application/vnd.github.machine-man-preview+json" - }, - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" } - }, - "url": "/app/installations" - }, - "listInstallationsForAuthenticatedUser": { - "headers": { - "accept": "application/vnd.github.machine-man-preview+json" - }, - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" } - }, - "url": "/user/installations" - }, - "listMarketplacePurchasesForAuthenticatedUser": { - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" } - }, - "url": "/user/marketplace_purchases" - }, - "listMarketplacePurchasesForAuthenticatedUserStubbed": { - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" } - }, - "url": "/user/marketplace_purchases/stubbed" - }, - "listPlans": { - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" } - }, - "url": "/marketplace_listing/plans" - }, - "listPlansStubbed": { - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" } - }, - "url": "/marketplace_listing/stubbed/plans" - }, - "listRepos": { - "headers": { - "accept": "application/vnd.github.machine-man-preview+json" - }, - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" } - }, - "url": "/installation/repositories" - }, - "removeRepoFromInstallation": { - "headers": { - "accept": "application/vnd.github.machine-man-preview+json" - }, - "method": "DELETE", - "params": { - "installation_id": { "required": true, "type": "integer" }, - "repository_id": { "required": true, "type": "integer" } - }, - "url": "/user/installations/:installation_id/repositories/:repository_id" - }, - "resetAuthorization": { - "deprecated": "octokit.oauthAuthorizations.resetAuthorization() has been renamed to octokit.apps.resetAuthorization() (2019-11-05)", - "method": "POST", - "params": { - "access_token": { "required": true, "type": "string" }, - "client_id": { "required": true, "type": "string" } - }, - "url": "/applications/:client_id/tokens/:access_token" - }, - "resetToken": { - "headers": { - "accept": "application/vnd.github.doctor-strange-preview+json" - }, - "method": "PATCH", - "params": { - "access_token": { "type": "string" }, - "client_id": { "required": true, "type": "string" } - }, - "url": "/applications/:client_id/token" - }, - "revokeAuthorizationForApplication": { - "deprecated": "octokit.oauthAuthorizations.revokeAuthorizationForApplication() has been renamed to octokit.apps.revokeAuthorizationForApplication() (2019-11-05)", - "method": "DELETE", - "params": { - "access_token": { "required": true, "type": "string" }, - "client_id": { "required": true, "type": "string" } - }, - "url": "/applications/:client_id/tokens/:access_token" - }, - "revokeGrantForApplication": { - "deprecated": "octokit.oauthAuthorizations.revokeGrantForApplication() has been renamed to octokit.apps.revokeGrantForApplication() (2019-11-05)", - "method": "DELETE", - "params": { - "access_token": { "required": true, "type": "string" }, - "client_id": { "required": true, "type": "string" } - }, - "url": "/applications/:client_id/grants/:access_token" - } - }, - "checks": { - "create": { - "headers": { "accept": "application/vnd.github.antiope-preview+json" }, - "method": "POST", - "params": { - "actions": { "type": "object[]" }, - "actions[].description": { "required": true, "type": "string" }, - "actions[].identifier": { "required": true, "type": "string" }, - "actions[].label": { "required": true, "type": "string" }, - "completed_at": { "type": "string" }, - "conclusion": { - "enum": [ - "success", - "failure", - "neutral", - "cancelled", - "timed_out", - "action_required" - ], - "type": "string" - }, - "details_url": { "type": "string" }, - "external_id": { "type": "string" }, - "head_sha": { "required": true, "type": "string" }, - "name": { "required": true, "type": "string" }, - "output": { "type": "object" }, - "output.annotations": { "type": "object[]" }, - "output.annotations[].annotation_level": { - "enum": ["notice", "warning", "failure"], - "required": true, - "type": "string" - }, - "output.annotations[].end_column": { "type": "integer" }, - "output.annotations[].end_line": { - "required": true, - "type": "integer" - }, - "output.annotations[].message": { "required": true, "type": "string" }, - "output.annotations[].path": { "required": true, "type": "string" }, - "output.annotations[].raw_details": { "type": "string" }, - "output.annotations[].start_column": { "type": "integer" }, - "output.annotations[].start_line": { - "required": true, - "type": "integer" - }, - "output.annotations[].title": { "type": "string" }, - "output.images": { "type": "object[]" }, - "output.images[].alt": { "required": true, "type": "string" }, - "output.images[].caption": { "type": "string" }, - "output.images[].image_url": { "required": true, "type": "string" }, - "output.summary": { "required": true, "type": "string" }, - "output.text": { "type": "string" }, - "output.title": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "started_at": { "type": "string" }, - "status": { - "enum": ["queued", "in_progress", "completed"], - "type": "string" - } - }, - "url": "/repos/:owner/:repo/check-runs" - }, - "createSuite": { - "headers": { "accept": "application/vnd.github.antiope-preview+json" }, - "method": "POST", - "params": { - "head_sha": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/check-suites" - }, - "get": { - "headers": { "accept": "application/vnd.github.antiope-preview+json" }, - "method": "GET", - "params": { - "check_run_id": { "required": true, "type": "integer" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/check-runs/:check_run_id" - }, - "getSuite": { - "headers": { "accept": "application/vnd.github.antiope-preview+json" }, - "method": "GET", - "params": { - "check_suite_id": { "required": true, "type": "integer" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/check-suites/:check_suite_id" - }, - "listAnnotations": { - "headers": { "accept": "application/vnd.github.antiope-preview+json" }, - "method": "GET", - "params": { - "check_run_id": { "required": true, "type": "integer" }, - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/check-runs/:check_run_id/annotations" - }, - "listForRef": { - "headers": { "accept": "application/vnd.github.antiope-preview+json" }, - "method": "GET", - "params": { - "check_name": { "type": "string" }, - "filter": { "enum": ["latest", "all"], "type": "string" }, - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "ref": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "status": { - "enum": ["queued", "in_progress", "completed"], - "type": "string" - } - }, - "url": "/repos/:owner/:repo/commits/:ref/check-runs" - }, - "listForSuite": { - "headers": { "accept": "application/vnd.github.antiope-preview+json" }, - "method": "GET", - "params": { - "check_name": { "type": "string" }, - "check_suite_id": { "required": true, "type": "integer" }, - "filter": { "enum": ["latest", "all"], "type": "string" }, - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "repo": { "required": true, "type": "string" }, - "status": { - "enum": ["queued", "in_progress", "completed"], - "type": "string" - } - }, - "url": "/repos/:owner/:repo/check-suites/:check_suite_id/check-runs" - }, - "listSuitesForRef": { - "headers": { "accept": "application/vnd.github.antiope-preview+json" }, - "method": "GET", - "params": { - "app_id": { "type": "integer" }, - "check_name": { "type": "string" }, - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "ref": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/commits/:ref/check-suites" - }, - "rerequestSuite": { - "headers": { "accept": "application/vnd.github.antiope-preview+json" }, - "method": "POST", - "params": { - "check_suite_id": { "required": true, "type": "integer" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/check-suites/:check_suite_id/rerequest" - }, - "setSuitesPreferences": { - "headers": { "accept": "application/vnd.github.antiope-preview+json" }, - "method": "PATCH", - "params": { - "auto_trigger_checks": { "type": "object[]" }, - "auto_trigger_checks[].app_id": { "required": true, "type": "integer" }, - "auto_trigger_checks[].setting": { - "required": true, - "type": "boolean" - }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/check-suites/preferences" - }, - "update": { - "headers": { "accept": "application/vnd.github.antiope-preview+json" }, - "method": "PATCH", - "params": { - "actions": { "type": "object[]" }, - "actions[].description": { "required": true, "type": "string" }, - "actions[].identifier": { "required": true, "type": "string" }, - "actions[].label": { "required": true, "type": "string" }, - "check_run_id": { "required": true, "type": "integer" }, - "completed_at": { "type": "string" }, - "conclusion": { - "enum": [ - "success", - "failure", - "neutral", - "cancelled", - "timed_out", - "action_required" - ], - "type": "string" - }, - "details_url": { "type": "string" }, - "external_id": { "type": "string" }, - "name": { "type": "string" }, - "output": { "type": "object" }, - "output.annotations": { "type": "object[]" }, - "output.annotations[].annotation_level": { - "enum": ["notice", "warning", "failure"], - "required": true, - "type": "string" - }, - "output.annotations[].end_column": { "type": "integer" }, - "output.annotations[].end_line": { - "required": true, - "type": "integer" - }, - "output.annotations[].message": { "required": true, "type": "string" }, - "output.annotations[].path": { "required": true, "type": "string" }, - "output.annotations[].raw_details": { "type": "string" }, - "output.annotations[].start_column": { "type": "integer" }, - "output.annotations[].start_line": { - "required": true, - "type": "integer" - }, - "output.annotations[].title": { "type": "string" }, - "output.images": { "type": "object[]" }, - "output.images[].alt": { "required": true, "type": "string" }, - "output.images[].caption": { "type": "string" }, - "output.images[].image_url": { "required": true, "type": "string" }, - "output.summary": { "required": true, "type": "string" }, - "output.text": { "type": "string" }, - "output.title": { "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "started_at": { "type": "string" }, - "status": { - "enum": ["queued", "in_progress", "completed"], - "type": "string" - } - }, - "url": "/repos/:owner/:repo/check-runs/:check_run_id" - } - }, - "codesOfConduct": { - "getConductCode": { - "headers": { - "accept": "application/vnd.github.scarlet-witch-preview+json" - }, - "method": "GET", - "params": { "key": { "required": true, "type": "string" } }, - "url": "/codes_of_conduct/:key" - }, - "getForRepo": { - "headers": { - "accept": "application/vnd.github.scarlet-witch-preview+json" - }, - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/community/code_of_conduct" - }, - "listConductCodes": { - "headers": { - "accept": "application/vnd.github.scarlet-witch-preview+json" - }, - "method": "GET", - "params": {}, - "url": "/codes_of_conduct" - } - }, - "emojis": { "get": { "method": "GET", "params": {}, "url": "/emojis" } }, - "gists": { - "checkIsStarred": { - "method": "GET", - "params": { "gist_id": { "required": true, "type": "string" } }, - "url": "/gists/:gist_id/star" - }, - "create": { - "method": "POST", - "params": { - "description": { "type": "string" }, - "files": { "required": true, "type": "object" }, - "files.content": { "type": "string" }, - "public": { "type": "boolean" } - }, - "url": "/gists" - }, - "createComment": { - "method": "POST", - "params": { - "body": { "required": true, "type": "string" }, - "gist_id": { "required": true, "type": "string" } - }, - "url": "/gists/:gist_id/comments" - }, - "delete": { - "method": "DELETE", - "params": { "gist_id": { "required": true, "type": "string" } }, - "url": "/gists/:gist_id" - }, - "deleteComment": { - "method": "DELETE", - "params": { - "comment_id": { "required": true, "type": "integer" }, - "gist_id": { "required": true, "type": "string" } - }, - "url": "/gists/:gist_id/comments/:comment_id" - }, - "fork": { - "method": "POST", - "params": { "gist_id": { "required": true, "type": "string" } }, - "url": "/gists/:gist_id/forks" - }, - "get": { - "method": "GET", - "params": { "gist_id": { "required": true, "type": "string" } }, - "url": "/gists/:gist_id" - }, - "getComment": { - "method": "GET", - "params": { - "comment_id": { "required": true, "type": "integer" }, - "gist_id": { "required": true, "type": "string" } - }, - "url": "/gists/:gist_id/comments/:comment_id" - }, - "getRevision": { - "method": "GET", - "params": { - "gist_id": { "required": true, "type": "string" }, - "sha": { "required": true, "type": "string" } - }, - "url": "/gists/:gist_id/:sha" - }, - "list": { - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "since": { "type": "string" } - }, - "url": "/gists" - }, - "listComments": { - "method": "GET", - "params": { - "gist_id": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" } - }, - "url": "/gists/:gist_id/comments" - }, - "listCommits": { - "method": "GET", - "params": { - "gist_id": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" } - }, - "url": "/gists/:gist_id/commits" - }, - "listForks": { - "method": "GET", - "params": { - "gist_id": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" } - }, - "url": "/gists/:gist_id/forks" - }, - "listPublic": { - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "since": { "type": "string" } - }, - "url": "/gists/public" - }, - "listPublicForUser": { - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "since": { "type": "string" }, - "username": { "required": true, "type": "string" } - }, - "url": "/users/:username/gists" - }, - "listStarred": { - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "since": { "type": "string" } - }, - "url": "/gists/starred" - }, - "star": { - "method": "PUT", - "params": { "gist_id": { "required": true, "type": "string" } }, - "url": "/gists/:gist_id/star" - }, - "unstar": { - "method": "DELETE", - "params": { "gist_id": { "required": true, "type": "string" } }, - "url": "/gists/:gist_id/star" - }, - "update": { - "method": "PATCH", - "params": { - "description": { "type": "string" }, - "files": { "type": "object" }, - "files.content": { "type": "string" }, - "files.filename": { "type": "string" }, - "gist_id": { "required": true, "type": "string" } - }, - "url": "/gists/:gist_id" - }, - "updateComment": { - "method": "PATCH", - "params": { - "body": { "required": true, "type": "string" }, - "comment_id": { "required": true, "type": "integer" }, - "gist_id": { "required": true, "type": "string" } - }, - "url": "/gists/:gist_id/comments/:comment_id" - } - }, - "git": { - "createBlob": { - "method": "POST", - "params": { - "content": { "required": true, "type": "string" }, - "encoding": { "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/git/blobs" - }, - "createCommit": { - "method": "POST", - "params": { - "author": { "type": "object" }, - "author.date": { "type": "string" }, - "author.email": { "type": "string" }, - "author.name": { "type": "string" }, - "committer": { "type": "object" }, - "committer.date": { "type": "string" }, - "committer.email": { "type": "string" }, - "committer.name": { "type": "string" }, - "message": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "parents": { "required": true, "type": "string[]" }, - "repo": { "required": true, "type": "string" }, - "signature": { "type": "string" }, - "tree": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/git/commits" - }, - "createRef": { - "method": "POST", - "params": { - "owner": { "required": true, "type": "string" }, - "ref": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "sha": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/git/refs" - }, - "createTag": { - "method": "POST", - "params": { - "message": { "required": true, "type": "string" }, - "object": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "tag": { "required": true, "type": "string" }, - "tagger": { "type": "object" }, - "tagger.date": { "type": "string" }, - "tagger.email": { "type": "string" }, - "tagger.name": { "type": "string" }, - "type": { - "enum": ["commit", "tree", "blob"], - "required": true, - "type": "string" - } - }, - "url": "/repos/:owner/:repo/git/tags" - }, - "createTree": { - "method": "POST", - "params": { - "base_tree": { "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "tree": { "required": true, "type": "object[]" }, - "tree[].content": { "type": "string" }, - "tree[].mode": { - "enum": ["100644", "100755", "040000", "160000", "120000"], - "type": "string" - }, - "tree[].path": { "type": "string" }, - "tree[].sha": { "allowNull": true, "type": "string" }, - "tree[].type": { "enum": ["blob", "tree", "commit"], "type": "string" } - }, - "url": "/repos/:owner/:repo/git/trees" - }, - "deleteRef": { - "method": "DELETE", - "params": { - "owner": { "required": true, "type": "string" }, - "ref": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/git/refs/:ref" - }, - "getBlob": { - "method": "GET", - "params": { - "file_sha": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/git/blobs/:file_sha" - }, - "getCommit": { - "method": "GET", - "params": { - "commit_sha": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/git/commits/:commit_sha" - }, - "getRef": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "ref": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/git/ref/:ref" - }, - "getTag": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "tag_sha": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/git/tags/:tag_sha" - }, - "getTree": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "recursive": { "enum": ["1"], "type": "integer" }, - "repo": { "required": true, "type": "string" }, - "tree_sha": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/git/trees/:tree_sha" - }, - "listMatchingRefs": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "ref": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/git/matching-refs/:ref" - }, - "listRefs": { - "method": "GET", - "params": { - "namespace": { "type": "string" }, - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/git/refs/:namespace" - }, - "updateRef": { - "method": "PATCH", - "params": { - "force": { "type": "boolean" }, - "owner": { "required": true, "type": "string" }, - "ref": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "sha": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/git/refs/:ref" - } - }, - "gitignore": { - "getTemplate": { - "method": "GET", - "params": { "name": { "required": true, "type": "string" } }, - "url": "/gitignore/templates/:name" - }, - "listTemplates": { - "method": "GET", - "params": {}, - "url": "/gitignore/templates" - } - }, - "interactions": { - "addOrUpdateRestrictionsForOrg": { - "headers": { "accept": "application/vnd.github.sombra-preview+json" }, - "method": "PUT", - "params": { - "limit": { - "enum": ["existing_users", "contributors_only", "collaborators_only"], - "required": true, - "type": "string" - }, - "org": { "required": true, "type": "string" } - }, - "url": "/orgs/:org/interaction-limits" - }, - "addOrUpdateRestrictionsForRepo": { - "headers": { "accept": "application/vnd.github.sombra-preview+json" }, - "method": "PUT", - "params": { - "limit": { - "enum": ["existing_users", "contributors_only", "collaborators_only"], - "required": true, - "type": "string" - }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/interaction-limits" - }, - "getRestrictionsForOrg": { - "headers": { "accept": "application/vnd.github.sombra-preview+json" }, - "method": "GET", - "params": { "org": { "required": true, "type": "string" } }, - "url": "/orgs/:org/interaction-limits" - }, - "getRestrictionsForRepo": { - "headers": { "accept": "application/vnd.github.sombra-preview+json" }, - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/interaction-limits" - }, - "removeRestrictionsForOrg": { - "headers": { "accept": "application/vnd.github.sombra-preview+json" }, - "method": "DELETE", - "params": { "org": { "required": true, "type": "string" } }, - "url": "/orgs/:org/interaction-limits" - }, - "removeRestrictionsForRepo": { - "headers": { "accept": "application/vnd.github.sombra-preview+json" }, - "method": "DELETE", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/interaction-limits" - } - }, - "issues": { - "addAssignees": { - "method": "POST", - "params": { - "assignees": { "type": "string[]" }, - "issue_number": { "required": true, "type": "integer" }, - "number": { - "alias": "issue_number", - "deprecated": true, - "type": "integer" - }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/issues/:issue_number/assignees" - }, - "addLabels": { - "method": "POST", - "params": { - "issue_number": { "required": true, "type": "integer" }, - "labels": { "required": true, "type": "string[]" }, - "number": { - "alias": "issue_number", - "deprecated": true, - "type": "integer" - }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/issues/:issue_number/labels" - }, - "checkAssignee": { - "method": "GET", - "params": { - "assignee": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/assignees/:assignee" - }, - "create": { - "method": "POST", - "params": { - "assignee": { "type": "string" }, - "assignees": { "type": "string[]" }, - "body": { "type": "string" }, - "labels": { "type": "string[]" }, - "milestone": { "type": "integer" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "title": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/issues" - }, - "createComment": { - "method": "POST", - "params": { - "body": { "required": true, "type": "string" }, - "issue_number": { "required": true, "type": "integer" }, - "number": { - "alias": "issue_number", - "deprecated": true, - "type": "integer" - }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/issues/:issue_number/comments" - }, - "createLabel": { - "method": "POST", - "params": { - "color": { "required": true, "type": "string" }, - "description": { "type": "string" }, - "name": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/labels" - }, - "createMilestone": { - "method": "POST", - "params": { - "description": { "type": "string" }, - "due_on": { "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "state": { "enum": ["open", "closed"], "type": "string" }, - "title": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/milestones" - }, - "deleteComment": { - "method": "DELETE", - "params": { - "comment_id": { "required": true, "type": "integer" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/issues/comments/:comment_id" - }, - "deleteLabel": { - "method": "DELETE", - "params": { - "name": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/labels/:name" - }, - "deleteMilestone": { - "method": "DELETE", - "params": { - "milestone_number": { "required": true, "type": "integer" }, - "number": { - "alias": "milestone_number", - "deprecated": true, - "type": "integer" - }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/milestones/:milestone_number" - }, - "get": { - "method": "GET", - "params": { - "issue_number": { "required": true, "type": "integer" }, - "number": { - "alias": "issue_number", - "deprecated": true, - "type": "integer" - }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/issues/:issue_number" - }, - "getComment": { - "method": "GET", - "params": { - "comment_id": { "required": true, "type": "integer" }, - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/issues/comments/:comment_id" - }, - "getEvent": { - "method": "GET", - "params": { - "event_id": { "required": true, "type": "integer" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/issues/events/:event_id" - }, - "getLabel": { - "method": "GET", - "params": { - "name": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/labels/:name" - }, - "getMilestone": { - "method": "GET", - "params": { - "milestone_number": { "required": true, "type": "integer" }, - "number": { - "alias": "milestone_number", - "deprecated": true, - "type": "integer" - }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/milestones/:milestone_number" - }, - "list": { - "method": "GET", - "params": { - "direction": { "enum": ["asc", "desc"], "type": "string" }, - "filter": { - "enum": ["assigned", "created", "mentioned", "subscribed", "all"], - "type": "string" - }, - "labels": { "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "since": { "type": "string" }, - "sort": { - "enum": ["created", "updated", "comments"], - "type": "string" - }, - "state": { "enum": ["open", "closed", "all"], "type": "string" } - }, - "url": "/issues" - }, - "listAssignees": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/assignees" - }, - "listComments": { - "method": "GET", - "params": { - "issue_number": { "required": true, "type": "integer" }, - "number": { - "alias": "issue_number", - "deprecated": true, - "type": "integer" - }, - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "repo": { "required": true, "type": "string" }, - "since": { "type": "string" } - }, - "url": "/repos/:owner/:repo/issues/:issue_number/comments" - }, - "listCommentsForRepo": { - "method": "GET", - "params": { - "direction": { "enum": ["asc", "desc"], "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "since": { "type": "string" }, - "sort": { "enum": ["created", "updated"], "type": "string" } - }, - "url": "/repos/:owner/:repo/issues/comments" - }, - "listEvents": { - "method": "GET", - "params": { - "issue_number": { "required": true, "type": "integer" }, - "number": { - "alias": "issue_number", - "deprecated": true, - "type": "integer" - }, - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/issues/:issue_number/events" - }, - "listEventsForRepo": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/issues/events" - }, - "listEventsForTimeline": { - "headers": { - "accept": "application/vnd.github.mockingbird-preview+json" - }, - "method": "GET", - "params": { - "issue_number": { "required": true, "type": "integer" }, - "number": { - "alias": "issue_number", - "deprecated": true, - "type": "integer" - }, - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/issues/:issue_number/timeline" - }, - "listForAuthenticatedUser": { - "method": "GET", - "params": { - "direction": { "enum": ["asc", "desc"], "type": "string" }, - "filter": { - "enum": ["assigned", "created", "mentioned", "subscribed", "all"], - "type": "string" - }, - "labels": { "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "since": { "type": "string" }, - "sort": { - "enum": ["created", "updated", "comments"], - "type": "string" - }, - "state": { "enum": ["open", "closed", "all"], "type": "string" } - }, - "url": "/user/issues" - }, - "listForOrg": { - "method": "GET", - "params": { - "direction": { "enum": ["asc", "desc"], "type": "string" }, - "filter": { - "enum": ["assigned", "created", "mentioned", "subscribed", "all"], - "type": "string" - }, - "labels": { "type": "string" }, - "org": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "since": { "type": "string" }, - "sort": { - "enum": ["created", "updated", "comments"], - "type": "string" - }, - "state": { "enum": ["open", "closed", "all"], "type": "string" } - }, - "url": "/orgs/:org/issues" - }, - "listForRepo": { - "method": "GET", - "params": { - "assignee": { "type": "string" }, - "creator": { "type": "string" }, - "direction": { "enum": ["asc", "desc"], "type": "string" }, - "labels": { "type": "string" }, - "mentioned": { "type": "string" }, - "milestone": { "type": "string" }, - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "repo": { "required": true, "type": "string" }, - "since": { "type": "string" }, - "sort": { - "enum": ["created", "updated", "comments"], - "type": "string" - }, - "state": { "enum": ["open", "closed", "all"], "type": "string" } - }, - "url": "/repos/:owner/:repo/issues" - }, - "listLabelsForMilestone": { - "method": "GET", - "params": { - "milestone_number": { "required": true, "type": "integer" }, - "number": { - "alias": "milestone_number", - "deprecated": true, - "type": "integer" - }, - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/milestones/:milestone_number/labels" - }, - "listLabelsForRepo": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/labels" - }, - "listLabelsOnIssue": { - "method": "GET", - "params": { - "issue_number": { "required": true, "type": "integer" }, - "number": { - "alias": "issue_number", - "deprecated": true, - "type": "integer" - }, - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/issues/:issue_number/labels" - }, - "listMilestonesForRepo": { - "method": "GET", - "params": { - "direction": { "enum": ["asc", "desc"], "type": "string" }, - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "repo": { "required": true, "type": "string" }, - "sort": { "enum": ["due_on", "completeness"], "type": "string" }, - "state": { "enum": ["open", "closed", "all"], "type": "string" } - }, - "url": "/repos/:owner/:repo/milestones" - }, - "lock": { - "method": "PUT", - "params": { - "issue_number": { "required": true, "type": "integer" }, - "lock_reason": { - "enum": ["off-topic", "too heated", "resolved", "spam"], - "type": "string" - }, - "number": { - "alias": "issue_number", - "deprecated": true, - "type": "integer" - }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/issues/:issue_number/lock" - }, - "removeAssignees": { - "method": "DELETE", - "params": { - "assignees": { "type": "string[]" }, - "issue_number": { "required": true, "type": "integer" }, - "number": { - "alias": "issue_number", - "deprecated": true, - "type": "integer" - }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/issues/:issue_number/assignees" - }, - "removeLabel": { - "method": "DELETE", - "params": { - "issue_number": { "required": true, "type": "integer" }, - "name": { "required": true, "type": "string" }, - "number": { - "alias": "issue_number", - "deprecated": true, - "type": "integer" - }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/issues/:issue_number/labels/:name" - }, - "removeLabels": { - "method": "DELETE", - "params": { - "issue_number": { "required": true, "type": "integer" }, - "number": { - "alias": "issue_number", - "deprecated": true, - "type": "integer" - }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/issues/:issue_number/labels" - }, - "replaceLabels": { - "method": "PUT", - "params": { - "issue_number": { "required": true, "type": "integer" }, - "labels": { "type": "string[]" }, - "number": { - "alias": "issue_number", - "deprecated": true, - "type": "integer" - }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/issues/:issue_number/labels" - }, - "unlock": { - "method": "DELETE", - "params": { - "issue_number": { "required": true, "type": "integer" }, - "number": { - "alias": "issue_number", - "deprecated": true, - "type": "integer" - }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/issues/:issue_number/lock" - }, - "update": { - "method": "PATCH", - "params": { - "assignee": { "type": "string" }, - "assignees": { "type": "string[]" }, - "body": { "type": "string" }, - "issue_number": { "required": true, "type": "integer" }, - "labels": { "type": "string[]" }, - "milestone": { "allowNull": true, "type": "integer" }, - "number": { - "alias": "issue_number", - "deprecated": true, - "type": "integer" - }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "state": { "enum": ["open", "closed"], "type": "string" }, - "title": { "type": "string" } - }, - "url": "/repos/:owner/:repo/issues/:issue_number" - }, - "updateComment": { - "method": "PATCH", - "params": { - "body": { "required": true, "type": "string" }, - "comment_id": { "required": true, "type": "integer" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/issues/comments/:comment_id" - }, - "updateLabel": { - "method": "PATCH", - "params": { - "color": { "type": "string" }, - "current_name": { "required": true, "type": "string" }, - "description": { "type": "string" }, - "name": { "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/labels/:current_name" - }, - "updateMilestone": { - "method": "PATCH", - "params": { - "description": { "type": "string" }, - "due_on": { "type": "string" }, - "milestone_number": { "required": true, "type": "integer" }, - "number": { - "alias": "milestone_number", - "deprecated": true, - "type": "integer" - }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "state": { "enum": ["open", "closed"], "type": "string" }, - "title": { "type": "string" } - }, - "url": "/repos/:owner/:repo/milestones/:milestone_number" - } - }, - "licenses": { - "get": { - "method": "GET", - "params": { "license": { "required": true, "type": "string" } }, - "url": "/licenses/:license" - }, - "getForRepo": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/license" - }, - "list": { - "deprecated": "octokit.licenses.list() has been renamed to octokit.licenses.listCommonlyUsed() (2019-03-05)", - "method": "GET", - "params": {}, - "url": "/licenses" - }, - "listCommonlyUsed": { "method": "GET", "params": {}, "url": "/licenses" } - }, - "markdown": { - "render": { - "method": "POST", - "params": { - "context": { "type": "string" }, - "mode": { "enum": ["markdown", "gfm"], "type": "string" }, - "text": { "required": true, "type": "string" } - }, - "url": "/markdown" - }, - "renderRaw": { - "headers": { "content-type": "text/plain; charset=utf-8" }, - "method": "POST", - "params": { - "data": { "mapTo": "data", "required": true, "type": "string" } - }, - "url": "/markdown/raw" - } - }, - "meta": { "get": { "method": "GET", "params": {}, "url": "/meta" } }, - "migrations": { - "cancelImport": { - "headers": { - "accept": "application/vnd.github.barred-rock-preview+json" - }, - "method": "DELETE", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/import" - }, - "deleteArchiveForAuthenticatedUser": { - "headers": { "accept": "application/vnd.github.wyandotte-preview+json" }, - "method": "DELETE", - "params": { "migration_id": { "required": true, "type": "integer" } }, - "url": "/user/migrations/:migration_id/archive" - }, - "deleteArchiveForOrg": { - "headers": { "accept": "application/vnd.github.wyandotte-preview+json" }, - "method": "DELETE", - "params": { - "migration_id": { "required": true, "type": "integer" }, - "org": { "required": true, "type": "string" } - }, - "url": "/orgs/:org/migrations/:migration_id/archive" - }, - "getArchiveForAuthenticatedUser": { - "headers": { "accept": "application/vnd.github.wyandotte-preview+json" }, - "method": "GET", - "params": { "migration_id": { "required": true, "type": "integer" } }, - "url": "/user/migrations/:migration_id/archive" - }, - "getArchiveForOrg": { - "headers": { "accept": "application/vnd.github.wyandotte-preview+json" }, - "method": "GET", - "params": { - "migration_id": { "required": true, "type": "integer" }, - "org": { "required": true, "type": "string" } - }, - "url": "/orgs/:org/migrations/:migration_id/archive" - }, - "getCommitAuthors": { - "headers": { - "accept": "application/vnd.github.barred-rock-preview+json" - }, - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "since": { "type": "string" } - }, - "url": "/repos/:owner/:repo/import/authors" - }, - "getImportProgress": { - "headers": { - "accept": "application/vnd.github.barred-rock-preview+json" - }, - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/import" - }, - "getLargeFiles": { - "headers": { - "accept": "application/vnd.github.barred-rock-preview+json" - }, - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/import/large_files" - }, - "getStatusForAuthenticatedUser": { - "headers": { "accept": "application/vnd.github.wyandotte-preview+json" }, - "method": "GET", - "params": { "migration_id": { "required": true, "type": "integer" } }, - "url": "/user/migrations/:migration_id" - }, - "getStatusForOrg": { - "headers": { "accept": "application/vnd.github.wyandotte-preview+json" }, - "method": "GET", - "params": { - "migration_id": { "required": true, "type": "integer" }, - "org": { "required": true, "type": "string" } - }, - "url": "/orgs/:org/migrations/:migration_id" - }, - "listForAuthenticatedUser": { - "headers": { "accept": "application/vnd.github.wyandotte-preview+json" }, - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" } - }, - "url": "/user/migrations" - }, - "listForOrg": { - "headers": { "accept": "application/vnd.github.wyandotte-preview+json" }, - "method": "GET", - "params": { - "org": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" } - }, - "url": "/orgs/:org/migrations" - }, - "mapCommitAuthor": { - "headers": { - "accept": "application/vnd.github.barred-rock-preview+json" - }, - "method": "PATCH", - "params": { - "author_id": { "required": true, "type": "integer" }, - "email": { "type": "string" }, - "name": { "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/import/authors/:author_id" - }, - "setLfsPreference": { - "headers": { - "accept": "application/vnd.github.barred-rock-preview+json" - }, - "method": "PATCH", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "use_lfs": { - "enum": ["opt_in", "opt_out"], - "required": true, - "type": "string" - } - }, - "url": "/repos/:owner/:repo/import/lfs" - }, - "startForAuthenticatedUser": { - "method": "POST", - "params": { - "exclude_attachments": { "type": "boolean" }, - "lock_repositories": { "type": "boolean" }, - "repositories": { "required": true, "type": "string[]" } - }, - "url": "/user/migrations" - }, - "startForOrg": { - "method": "POST", - "params": { - "exclude_attachments": { "type": "boolean" }, - "lock_repositories": { "type": "boolean" }, - "org": { "required": true, "type": "string" }, - "repositories": { "required": true, "type": "string[]" } - }, - "url": "/orgs/:org/migrations" - }, - "startImport": { - "headers": { - "accept": "application/vnd.github.barred-rock-preview+json" - }, - "method": "PUT", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "tfvc_project": { "type": "string" }, - "vcs": { - "enum": ["subversion", "git", "mercurial", "tfvc"], - "type": "string" - }, - "vcs_password": { "type": "string" }, - "vcs_url": { "required": true, "type": "string" }, - "vcs_username": { "type": "string" } - }, - "url": "/repos/:owner/:repo/import" - }, - "unlockRepoForAuthenticatedUser": { - "headers": { "accept": "application/vnd.github.wyandotte-preview+json" }, - "method": "DELETE", - "params": { - "migration_id": { "required": true, "type": "integer" }, - "repo_name": { "required": true, "type": "string" } - }, - "url": "/user/migrations/:migration_id/repos/:repo_name/lock" - }, - "unlockRepoForOrg": { - "headers": { "accept": "application/vnd.github.wyandotte-preview+json" }, - "method": "DELETE", - "params": { - "migration_id": { "required": true, "type": "integer" }, - "org": { "required": true, "type": "string" }, - "repo_name": { "required": true, "type": "string" } - }, - "url": "/orgs/:org/migrations/:migration_id/repos/:repo_name/lock" - }, - "updateImport": { - "headers": { - "accept": "application/vnd.github.barred-rock-preview+json" - }, - "method": "PATCH", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "vcs_password": { "type": "string" }, - "vcs_username": { "type": "string" } - }, - "url": "/repos/:owner/:repo/import" - } - }, - "oauthAuthorizations": { - "checkAuthorization": { - "deprecated": "octokit.oauthAuthorizations.checkAuthorization() has been renamed to octokit.apps.checkAuthorization() (2019-11-05)", - "method": "GET", - "params": { - "access_token": { "required": true, "type": "string" }, - "client_id": { "required": true, "type": "string" } - }, - "url": "/applications/:client_id/tokens/:access_token" - }, - "createAuthorization": { - "deprecated": "octokit.oauthAuthorizations.createAuthorization() is deprecated, see https://developer.github.com/v3/oauth_authorizations/#create-a-new-authorization", - "method": "POST", - "params": { - "client_id": { "type": "string" }, - "client_secret": { "type": "string" }, - "fingerprint": { "type": "string" }, - "note": { "required": true, "type": "string" }, - "note_url": { "type": "string" }, - "scopes": { "type": "string[]" } - }, - "url": "/authorizations" - }, - "deleteAuthorization": { - "deprecated": "octokit.oauthAuthorizations.deleteAuthorization() is deprecated, see https://developer.github.com/v3/oauth_authorizations/#delete-an-authorization", - "method": "DELETE", - "params": { "authorization_id": { "required": true, "type": "integer" } }, - "url": "/authorizations/:authorization_id" - }, - "deleteGrant": { - "deprecated": "octokit.oauthAuthorizations.deleteGrant() is deprecated, see https://developer.github.com/v3/oauth_authorizations/#delete-a-grant", - "method": "DELETE", - "params": { "grant_id": { "required": true, "type": "integer" } }, - "url": "/applications/grants/:grant_id" - }, - "getAuthorization": { - "deprecated": "octokit.oauthAuthorizations.getAuthorization() is deprecated, see https://developer.github.com/v3/oauth_authorizations/#get-a-single-authorization", - "method": "GET", - "params": { "authorization_id": { "required": true, "type": "integer" } }, - "url": "/authorizations/:authorization_id" - }, - "getGrant": { - "deprecated": "octokit.oauthAuthorizations.getGrant() is deprecated, see https://developer.github.com/v3/oauth_authorizations/#get-a-single-grant", - "method": "GET", - "params": { "grant_id": { "required": true, "type": "integer" } }, - "url": "/applications/grants/:grant_id" - }, - "getOrCreateAuthorizationForApp": { - "deprecated": "octokit.oauthAuthorizations.getOrCreateAuthorizationForApp() is deprecated, see https://developer.github.com/v3/oauth_authorizations/#get-or-create-an-authorization-for-a-specific-app", - "method": "PUT", - "params": { - "client_id": { "required": true, "type": "string" }, - "client_secret": { "required": true, "type": "string" }, - "fingerprint": { "type": "string" }, - "note": { "type": "string" }, - "note_url": { "type": "string" }, - "scopes": { "type": "string[]" } - }, - "url": "/authorizations/clients/:client_id" - }, - "getOrCreateAuthorizationForAppAndFingerprint": { - "deprecated": "octokit.oauthAuthorizations.getOrCreateAuthorizationForAppAndFingerprint() is deprecated, see https://developer.github.com/v3/oauth_authorizations/#get-or-create-an-authorization-for-a-specific-app-and-fingerprint", - "method": "PUT", - "params": { - "client_id": { "required": true, "type": "string" }, - "client_secret": { "required": true, "type": "string" }, - "fingerprint": { "required": true, "type": "string" }, - "note": { "type": "string" }, - "note_url": { "type": "string" }, - "scopes": { "type": "string[]" } - }, - "url": "/authorizations/clients/:client_id/:fingerprint" - }, - "getOrCreateAuthorizationForAppFingerprint": { - "deprecated": "octokit.oauthAuthorizations.getOrCreateAuthorizationForAppFingerprint() has been renamed to octokit.oauthAuthorizations.getOrCreateAuthorizationForAppAndFingerprint() (2018-12-27)", - "method": "PUT", - "params": { - "client_id": { "required": true, "type": "string" }, - "client_secret": { "required": true, "type": "string" }, - "fingerprint": { "required": true, "type": "string" }, - "note": { "type": "string" }, - "note_url": { "type": "string" }, - "scopes": { "type": "string[]" } - }, - "url": "/authorizations/clients/:client_id/:fingerprint" - }, - "listAuthorizations": { - "deprecated": "octokit.oauthAuthorizations.listAuthorizations() is deprecated, see https://developer.github.com/v3/oauth_authorizations/#list-your-authorizations", - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" } - }, - "url": "/authorizations" - }, - "listGrants": { - "deprecated": "octokit.oauthAuthorizations.listGrants() is deprecated, see https://developer.github.com/v3/oauth_authorizations/#list-your-grants", - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" } - }, - "url": "/applications/grants" - }, - "resetAuthorization": { - "deprecated": "octokit.oauthAuthorizations.resetAuthorization() has been renamed to octokit.apps.resetAuthorization() (2019-11-05)", - "method": "POST", - "params": { - "access_token": { "required": true, "type": "string" }, - "client_id": { "required": true, "type": "string" } - }, - "url": "/applications/:client_id/tokens/:access_token" - }, - "revokeAuthorizationForApplication": { - "deprecated": "octokit.oauthAuthorizations.revokeAuthorizationForApplication() has been renamed to octokit.apps.revokeAuthorizationForApplication() (2019-11-05)", - "method": "DELETE", - "params": { - "access_token": { "required": true, "type": "string" }, - "client_id": { "required": true, "type": "string" } - }, - "url": "/applications/:client_id/tokens/:access_token" - }, - "revokeGrantForApplication": { - "deprecated": "octokit.oauthAuthorizations.revokeGrantForApplication() has been renamed to octokit.apps.revokeGrantForApplication() (2019-11-05)", - "method": "DELETE", - "params": { - "access_token": { "required": true, "type": "string" }, - "client_id": { "required": true, "type": "string" } - }, - "url": "/applications/:client_id/grants/:access_token" - }, - "updateAuthorization": { - "deprecated": "octokit.oauthAuthorizations.updateAuthorization() is deprecated, see https://developer.github.com/v3/oauth_authorizations/#update-an-existing-authorization", - "method": "PATCH", - "params": { - "add_scopes": { "type": "string[]" }, - "authorization_id": { "required": true, "type": "integer" }, - "fingerprint": { "type": "string" }, - "note": { "type": "string" }, - "note_url": { "type": "string" }, - "remove_scopes": { "type": "string[]" }, - "scopes": { "type": "string[]" } - }, - "url": "/authorizations/:authorization_id" - } - }, - "orgs": { - "addOrUpdateMembership": { - "method": "PUT", - "params": { - "org": { "required": true, "type": "string" }, - "role": { "enum": ["admin", "member"], "type": "string" }, - "username": { "required": true, "type": "string" } - }, - "url": "/orgs/:org/memberships/:username" - }, - "blockUser": { - "method": "PUT", - "params": { - "org": { "required": true, "type": "string" }, - "username": { "required": true, "type": "string" } - }, - "url": "/orgs/:org/blocks/:username" - }, - "checkBlockedUser": { - "method": "GET", - "params": { - "org": { "required": true, "type": "string" }, - "username": { "required": true, "type": "string" } - }, - "url": "/orgs/:org/blocks/:username" - }, - "checkMembership": { - "method": "GET", - "params": { - "org": { "required": true, "type": "string" }, - "username": { "required": true, "type": "string" } - }, - "url": "/orgs/:org/members/:username" - }, - "checkPublicMembership": { - "method": "GET", - "params": { - "org": { "required": true, "type": "string" }, - "username": { "required": true, "type": "string" } - }, - "url": "/orgs/:org/public_members/:username" - }, - "concealMembership": { - "method": "DELETE", - "params": { - "org": { "required": true, "type": "string" }, - "username": { "required": true, "type": "string" } - }, - "url": "/orgs/:org/public_members/:username" - }, - "convertMemberToOutsideCollaborator": { - "method": "PUT", - "params": { - "org": { "required": true, "type": "string" }, - "username": { "required": true, "type": "string" } - }, - "url": "/orgs/:org/outside_collaborators/:username" - }, - "createHook": { - "method": "POST", - "params": { - "active": { "type": "boolean" }, - "config": { "required": true, "type": "object" }, - "config.content_type": { "type": "string" }, - "config.insecure_ssl": { "type": "string" }, - "config.secret": { "type": "string" }, - "config.url": { "required": true, "type": "string" }, - "events": { "type": "string[]" }, - "name": { "required": true, "type": "string" }, - "org": { "required": true, "type": "string" } - }, - "url": "/orgs/:org/hooks" - }, - "createInvitation": { - "method": "POST", - "params": { - "email": { "type": "string" }, - "invitee_id": { "type": "integer" }, - "org": { "required": true, "type": "string" }, - "role": { - "enum": ["admin", "direct_member", "billing_manager"], - "type": "string" - }, - "team_ids": { "type": "integer[]" } - }, - "url": "/orgs/:org/invitations" - }, - "deleteHook": { - "method": "DELETE", - "params": { - "hook_id": { "required": true, "type": "integer" }, - "org": { "required": true, "type": "string" } - }, - "url": "/orgs/:org/hooks/:hook_id" - }, - "get": { - "method": "GET", - "params": { "org": { "required": true, "type": "string" } }, - "url": "/orgs/:org" - }, - "getHook": { - "method": "GET", - "params": { - "hook_id": { "required": true, "type": "integer" }, - "org": { "required": true, "type": "string" } - }, - "url": "/orgs/:org/hooks/:hook_id" - }, - "getMembership": { - "method": "GET", - "params": { - "org": { "required": true, "type": "string" }, - "username": { "required": true, "type": "string" } - }, - "url": "/orgs/:org/memberships/:username" - }, - "getMembershipForAuthenticatedUser": { - "method": "GET", - "params": { "org": { "required": true, "type": "string" } }, - "url": "/user/memberships/orgs/:org" - }, - "list": { - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "since": { "type": "string" } - }, - "url": "/organizations" - }, - "listBlockedUsers": { - "method": "GET", - "params": { "org": { "required": true, "type": "string" } }, - "url": "/orgs/:org/blocks" - }, - "listForAuthenticatedUser": { - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" } - }, - "url": "/user/orgs" - }, - "listForUser": { - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "username": { "required": true, "type": "string" } - }, - "url": "/users/:username/orgs" - }, - "listHooks": { - "method": "GET", - "params": { - "org": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" } - }, - "url": "/orgs/:org/hooks" - }, - "listInstallations": { - "headers": { - "accept": "application/vnd.github.machine-man-preview+json" - }, - "method": "GET", - "params": { - "org": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" } - }, - "url": "/orgs/:org/installations" - }, - "listInvitationTeams": { - "method": "GET", - "params": { - "invitation_id": { "required": true, "type": "integer" }, - "org": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" } - }, - "url": "/orgs/:org/invitations/:invitation_id/teams" - }, - "listMembers": { - "method": "GET", - "params": { - "filter": { "enum": ["2fa_disabled", "all"], "type": "string" }, - "org": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "role": { "enum": ["all", "admin", "member"], "type": "string" } - }, - "url": "/orgs/:org/members" - }, - "listMemberships": { - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "state": { "enum": ["active", "pending"], "type": "string" } - }, - "url": "/user/memberships/orgs" - }, - "listOutsideCollaborators": { - "method": "GET", - "params": { - "filter": { "enum": ["2fa_disabled", "all"], "type": "string" }, - "org": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" } - }, - "url": "/orgs/:org/outside_collaborators" - }, - "listPendingInvitations": { - "method": "GET", - "params": { - "org": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" } - }, - "url": "/orgs/:org/invitations" - }, - "listPublicMembers": { - "method": "GET", - "params": { - "org": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" } - }, - "url": "/orgs/:org/public_members" - }, - "pingHook": { - "method": "POST", - "params": { - "hook_id": { "required": true, "type": "integer" }, - "org": { "required": true, "type": "string" } - }, - "url": "/orgs/:org/hooks/:hook_id/pings" - }, - "publicizeMembership": { - "method": "PUT", - "params": { - "org": { "required": true, "type": "string" }, - "username": { "required": true, "type": "string" } - }, - "url": "/orgs/:org/public_members/:username" - }, - "removeMember": { - "method": "DELETE", - "params": { - "org": { "required": true, "type": "string" }, - "username": { "required": true, "type": "string" } - }, - "url": "/orgs/:org/members/:username" - }, - "removeMembership": { - "method": "DELETE", - "params": { - "org": { "required": true, "type": "string" }, - "username": { "required": true, "type": "string" } - }, - "url": "/orgs/:org/memberships/:username" - }, - "removeOutsideCollaborator": { - "method": "DELETE", - "params": { - "org": { "required": true, "type": "string" }, - "username": { "required": true, "type": "string" } - }, - "url": "/orgs/:org/outside_collaborators/:username" - }, - "unblockUser": { - "method": "DELETE", - "params": { - "org": { "required": true, "type": "string" }, - "username": { "required": true, "type": "string" } - }, - "url": "/orgs/:org/blocks/:username" - }, - "update": { - "method": "PATCH", - "params": { - "billing_email": { "type": "string" }, - "company": { "type": "string" }, - "default_repository_permission": { - "enum": ["read", "write", "admin", "none"], - "type": "string" - }, - "description": { "type": "string" }, - "email": { "type": "string" }, - "has_organization_projects": { "type": "boolean" }, - "has_repository_projects": { "type": "boolean" }, - "location": { "type": "string" }, - "members_allowed_repository_creation_type": { - "enum": ["all", "private", "none"], - "type": "string" - }, - "members_can_create_repositories": { "type": "boolean" }, - "name": { "type": "string" }, - "org": { "required": true, "type": "string" } - }, - "url": "/orgs/:org" - }, - "updateHook": { - "method": "PATCH", - "params": { - "active": { "type": "boolean" }, - "config": { "type": "object" }, - "config.content_type": { "type": "string" }, - "config.insecure_ssl": { "type": "string" }, - "config.secret": { "type": "string" }, - "config.url": { "required": true, "type": "string" }, - "events": { "type": "string[]" }, - "hook_id": { "required": true, "type": "integer" }, - "org": { "required": true, "type": "string" } - }, - "url": "/orgs/:org/hooks/:hook_id" - }, - "updateMembership": { - "method": "PATCH", - "params": { - "org": { "required": true, "type": "string" }, - "state": { "enum": ["active"], "required": true, "type": "string" } - }, - "url": "/user/memberships/orgs/:org" - } - }, - "projects": { - "addCollaborator": { - "headers": { "accept": "application/vnd.github.inertia-preview+json" }, - "method": "PUT", - "params": { - "permission": { "enum": ["read", "write", "admin"], "type": "string" }, - "project_id": { "required": true, "type": "integer" }, - "username": { "required": true, "type": "string" } - }, - "url": "/projects/:project_id/collaborators/:username" - }, - "createCard": { - "headers": { "accept": "application/vnd.github.inertia-preview+json" }, - "method": "POST", - "params": { - "column_id": { "required": true, "type": "integer" }, - "content_id": { "type": "integer" }, - "content_type": { "type": "string" }, - "note": { "type": "string" } - }, - "url": "/projects/columns/:column_id/cards" - }, - "createColumn": { - "headers": { "accept": "application/vnd.github.inertia-preview+json" }, - "method": "POST", - "params": { - "name": { "required": true, "type": "string" }, - "project_id": { "required": true, "type": "integer" } - }, - "url": "/projects/:project_id/columns" - }, - "createForAuthenticatedUser": { - "headers": { "accept": "application/vnd.github.inertia-preview+json" }, - "method": "POST", - "params": { - "body": { "type": "string" }, - "name": { "required": true, "type": "string" } - }, - "url": "/user/projects" - }, - "createForOrg": { - "headers": { "accept": "application/vnd.github.inertia-preview+json" }, - "method": "POST", - "params": { - "body": { "type": "string" }, - "name": { "required": true, "type": "string" }, - "org": { "required": true, "type": "string" } - }, - "url": "/orgs/:org/projects" - }, - "createForRepo": { - "headers": { "accept": "application/vnd.github.inertia-preview+json" }, - "method": "POST", - "params": { - "body": { "type": "string" }, - "name": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/projects" - }, - "delete": { - "headers": { "accept": "application/vnd.github.inertia-preview+json" }, - "method": "DELETE", - "params": { "project_id": { "required": true, "type": "integer" } }, - "url": "/projects/:project_id" - }, - "deleteCard": { - "headers": { "accept": "application/vnd.github.inertia-preview+json" }, - "method": "DELETE", - "params": { "card_id": { "required": true, "type": "integer" } }, - "url": "/projects/columns/cards/:card_id" - }, - "deleteColumn": { - "headers": { "accept": "application/vnd.github.inertia-preview+json" }, - "method": "DELETE", - "params": { "column_id": { "required": true, "type": "integer" } }, - "url": "/projects/columns/:column_id" - }, - "get": { - "headers": { "accept": "application/vnd.github.inertia-preview+json" }, - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "project_id": { "required": true, "type": "integer" } - }, - "url": "/projects/:project_id" - }, - "getCard": { - "headers": { "accept": "application/vnd.github.inertia-preview+json" }, - "method": "GET", - "params": { "card_id": { "required": true, "type": "integer" } }, - "url": "/projects/columns/cards/:card_id" - }, - "getColumn": { - "headers": { "accept": "application/vnd.github.inertia-preview+json" }, - "method": "GET", - "params": { "column_id": { "required": true, "type": "integer" } }, - "url": "/projects/columns/:column_id" - }, - "listCards": { - "headers": { "accept": "application/vnd.github.inertia-preview+json" }, - "method": "GET", - "params": { - "archived_state": { - "enum": ["all", "archived", "not_archived"], - "type": "string" - }, - "column_id": { "required": true, "type": "integer" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" } - }, - "url": "/projects/columns/:column_id/cards" - }, - "listCollaborators": { - "headers": { "accept": "application/vnd.github.inertia-preview+json" }, - "method": "GET", - "params": { - "affiliation": { - "enum": ["outside", "direct", "all"], - "type": "string" - }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "project_id": { "required": true, "type": "integer" } - }, - "url": "/projects/:project_id/collaborators" - }, - "listColumns": { - "headers": { "accept": "application/vnd.github.inertia-preview+json" }, - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "project_id": { "required": true, "type": "integer" } - }, - "url": "/projects/:project_id/columns" - }, - "listForOrg": { - "headers": { "accept": "application/vnd.github.inertia-preview+json" }, - "method": "GET", - "params": { - "org": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "state": { "enum": ["open", "closed", "all"], "type": "string" } - }, - "url": "/orgs/:org/projects" - }, - "listForRepo": { - "headers": { "accept": "application/vnd.github.inertia-preview+json" }, - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "repo": { "required": true, "type": "string" }, - "state": { "enum": ["open", "closed", "all"], "type": "string" } - }, - "url": "/repos/:owner/:repo/projects" - }, - "listForUser": { - "headers": { "accept": "application/vnd.github.inertia-preview+json" }, - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "state": { "enum": ["open", "closed", "all"], "type": "string" }, - "username": { "required": true, "type": "string" } - }, - "url": "/users/:username/projects" - }, - "moveCard": { - "headers": { "accept": "application/vnd.github.inertia-preview+json" }, - "method": "POST", - "params": { - "card_id": { "required": true, "type": "integer" }, - "column_id": { "type": "integer" }, - "position": { - "required": true, - "type": "string", - "validation": "^(top|bottom|after:\\d+)$" - } - }, - "url": "/projects/columns/cards/:card_id/moves" - }, - "moveColumn": { - "headers": { "accept": "application/vnd.github.inertia-preview+json" }, - "method": "POST", - "params": { - "column_id": { "required": true, "type": "integer" }, - "position": { - "required": true, - "type": "string", - "validation": "^(first|last|after:\\d+)$" - } - }, - "url": "/projects/columns/:column_id/moves" - }, - "removeCollaborator": { - "headers": { "accept": "application/vnd.github.inertia-preview+json" }, - "method": "DELETE", - "params": { - "project_id": { "required": true, "type": "integer" }, - "username": { "required": true, "type": "string" } - }, - "url": "/projects/:project_id/collaborators/:username" - }, - "reviewUserPermissionLevel": { - "headers": { "accept": "application/vnd.github.inertia-preview+json" }, - "method": "GET", - "params": { - "project_id": { "required": true, "type": "integer" }, - "username": { "required": true, "type": "string" } - }, - "url": "/projects/:project_id/collaborators/:username/permission" - }, - "update": { - "headers": { "accept": "application/vnd.github.inertia-preview+json" }, - "method": "PATCH", - "params": { - "body": { "type": "string" }, - "name": { "type": "string" }, - "organization_permission": { "type": "string" }, - "private": { "type": "boolean" }, - "project_id": { "required": true, "type": "integer" }, - "state": { "enum": ["open", "closed"], "type": "string" } - }, - "url": "/projects/:project_id" - }, - "updateCard": { - "headers": { "accept": "application/vnd.github.inertia-preview+json" }, - "method": "PATCH", - "params": { - "archived": { "type": "boolean" }, - "card_id": { "required": true, "type": "integer" }, - "note": { "type": "string" } - }, - "url": "/projects/columns/cards/:card_id" - }, - "updateColumn": { - "headers": { "accept": "application/vnd.github.inertia-preview+json" }, - "method": "PATCH", - "params": { - "column_id": { "required": true, "type": "integer" }, - "name": { "required": true, "type": "string" } - }, - "url": "/projects/columns/:column_id" - } - }, - "pulls": { - "checkIfMerged": { - "method": "GET", - "params": { - "number": { - "alias": "pull_number", - "deprecated": true, - "type": "integer" - }, - "owner": { "required": true, "type": "string" }, - "pull_number": { "required": true, "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/pulls/:pull_number/merge" - }, - "create": { - "method": "POST", - "params": { - "base": { "required": true, "type": "string" }, - "body": { "type": "string" }, - "draft": { "type": "boolean" }, - "head": { "required": true, "type": "string" }, - "maintainer_can_modify": { "type": "boolean" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "title": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/pulls" - }, - "createComment": { - "method": "POST", - "params": { - "body": { "required": true, "type": "string" }, - "commit_id": { "required": true, "type": "string" }, - "in_reply_to": { - "deprecated": true, - "description": "The comment ID to reply to. **Note**: This must be the ID of a top-level comment, not a reply to that comment. Replies to replies are not supported.", - "type": "integer" - }, - "line": { "type": "integer" }, - "number": { - "alias": "pull_number", - "deprecated": true, - "type": "integer" - }, - "owner": { "required": true, "type": "string" }, - "path": { "required": true, "type": "string" }, - "position": { "type": "integer" }, - "pull_number": { "required": true, "type": "integer" }, - "repo": { "required": true, "type": "string" }, - "side": { "enum": ["LEFT", "RIGHT"], "type": "string" }, - "start_line": { "type": "integer" }, - "start_side": { "enum": ["LEFT", "RIGHT", "side"], "type": "string" } - }, - "url": "/repos/:owner/:repo/pulls/:pull_number/comments" - }, - "createCommentReply": { - "deprecated": "octokit.pulls.createCommentReply() has been renamed to octokit.pulls.createComment() (2019-09-09)", - "method": "POST", - "params": { - "body": { "required": true, "type": "string" }, - "commit_id": { "required": true, "type": "string" }, - "in_reply_to": { - "deprecated": true, - "description": "The comment ID to reply to. **Note**: This must be the ID of a top-level comment, not a reply to that comment. Replies to replies are not supported.", - "type": "integer" - }, - "line": { "type": "integer" }, - "number": { - "alias": "pull_number", - "deprecated": true, - "type": "integer" - }, - "owner": { "required": true, "type": "string" }, - "path": { "required": true, "type": "string" }, - "position": { "type": "integer" }, - "pull_number": { "required": true, "type": "integer" }, - "repo": { "required": true, "type": "string" }, - "side": { "enum": ["LEFT", "RIGHT"], "type": "string" }, - "start_line": { "type": "integer" }, - "start_side": { "enum": ["LEFT", "RIGHT", "side"], "type": "string" } - }, - "url": "/repos/:owner/:repo/pulls/:pull_number/comments" - }, - "createFromIssue": { - "deprecated": "octokit.pulls.createFromIssue() is deprecated, see https://developer.github.com/v3/pulls/#create-a-pull-request", - "method": "POST", - "params": { - "base": { "required": true, "type": "string" }, - "draft": { "type": "boolean" }, - "head": { "required": true, "type": "string" }, - "issue": { "required": true, "type": "integer" }, - "maintainer_can_modify": { "type": "boolean" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/pulls" - }, - "createReview": { - "method": "POST", - "params": { - "body": { "type": "string" }, - "comments": { "type": "object[]" }, - "comments[].body": { "required": true, "type": "string" }, - "comments[].path": { "required": true, "type": "string" }, - "comments[].position": { "required": true, "type": "integer" }, - "commit_id": { "type": "string" }, - "event": { - "enum": ["APPROVE", "REQUEST_CHANGES", "COMMENT"], - "type": "string" - }, - "number": { - "alias": "pull_number", - "deprecated": true, - "type": "integer" - }, - "owner": { "required": true, "type": "string" }, - "pull_number": { "required": true, "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/pulls/:pull_number/reviews" - }, - "createReviewCommentReply": { - "method": "POST", - "params": { - "body": { "required": true, "type": "string" }, - "comment_id": { "required": true, "type": "integer" }, - "owner": { "required": true, "type": "string" }, - "pull_number": { "required": true, "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/pulls/:pull_number/comments/:comment_id/replies" - }, - "createReviewRequest": { - "method": "POST", - "params": { - "number": { - "alias": "pull_number", - "deprecated": true, - "type": "integer" - }, - "owner": { "required": true, "type": "string" }, - "pull_number": { "required": true, "type": "integer" }, - "repo": { "required": true, "type": "string" }, - "reviewers": { "type": "string[]" }, - "team_reviewers": { "type": "string[]" } - }, - "url": "/repos/:owner/:repo/pulls/:pull_number/requested_reviewers" - }, - "deleteComment": { - "method": "DELETE", - "params": { - "comment_id": { "required": true, "type": "integer" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/pulls/comments/:comment_id" - }, - "deletePendingReview": { - "method": "DELETE", - "params": { - "number": { - "alias": "pull_number", - "deprecated": true, - "type": "integer" - }, - "owner": { "required": true, "type": "string" }, - "pull_number": { "required": true, "type": "integer" }, - "repo": { "required": true, "type": "string" }, - "review_id": { "required": true, "type": "integer" } - }, - "url": "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id" - }, - "deleteReviewRequest": { - "method": "DELETE", - "params": { - "number": { - "alias": "pull_number", - "deprecated": true, - "type": "integer" - }, - "owner": { "required": true, "type": "string" }, - "pull_number": { "required": true, "type": "integer" }, - "repo": { "required": true, "type": "string" }, - "reviewers": { "type": "string[]" }, - "team_reviewers": { "type": "string[]" } - }, - "url": "/repos/:owner/:repo/pulls/:pull_number/requested_reviewers" - }, - "dismissReview": { - "method": "PUT", - "params": { - "message": { "required": true, "type": "string" }, - "number": { - "alias": "pull_number", - "deprecated": true, - "type": "integer" - }, - "owner": { "required": true, "type": "string" }, - "pull_number": { "required": true, "type": "integer" }, - "repo": { "required": true, "type": "string" }, - "review_id": { "required": true, "type": "integer" } - }, - "url": "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/dismissals" - }, - "get": { - "method": "GET", - "params": { - "number": { - "alias": "pull_number", - "deprecated": true, - "type": "integer" - }, - "owner": { "required": true, "type": "string" }, - "pull_number": { "required": true, "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/pulls/:pull_number" - }, - "getComment": { - "method": "GET", - "params": { - "comment_id": { "required": true, "type": "integer" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/pulls/comments/:comment_id" - }, - "getCommentsForReview": { - "method": "GET", - "params": { - "number": { - "alias": "pull_number", - "deprecated": true, - "type": "integer" - }, - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "pull_number": { "required": true, "type": "integer" }, - "repo": { "required": true, "type": "string" }, - "review_id": { "required": true, "type": "integer" } - }, - "url": "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/comments" - }, - "getReview": { - "method": "GET", - "params": { - "number": { - "alias": "pull_number", - "deprecated": true, - "type": "integer" - }, - "owner": { "required": true, "type": "string" }, - "pull_number": { "required": true, "type": "integer" }, - "repo": { "required": true, "type": "string" }, - "review_id": { "required": true, "type": "integer" } - }, - "url": "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id" - }, - "list": { - "method": "GET", - "params": { - "base": { "type": "string" }, - "direction": { "enum": ["asc", "desc"], "type": "string" }, - "head": { "type": "string" }, - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "repo": { "required": true, "type": "string" }, - "sort": { - "enum": ["created", "updated", "popularity", "long-running"], - "type": "string" - }, - "state": { "enum": ["open", "closed", "all"], "type": "string" } - }, - "url": "/repos/:owner/:repo/pulls" - }, - "listComments": { - "method": "GET", - "params": { - "direction": { "enum": ["asc", "desc"], "type": "string" }, - "number": { - "alias": "pull_number", - "deprecated": true, - "type": "integer" - }, - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "pull_number": { "required": true, "type": "integer" }, - "repo": { "required": true, "type": "string" }, - "since": { "type": "string" }, - "sort": { "enum": ["created", "updated"], "type": "string" } - }, - "url": "/repos/:owner/:repo/pulls/:pull_number/comments" - }, - "listCommentsForRepo": { - "method": "GET", - "params": { - "direction": { "enum": ["asc", "desc"], "type": "string" }, - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "repo": { "required": true, "type": "string" }, - "since": { "type": "string" }, - "sort": { "enum": ["created", "updated"], "type": "string" } - }, - "url": "/repos/:owner/:repo/pulls/comments" - }, - "listCommits": { - "method": "GET", - "params": { - "number": { - "alias": "pull_number", - "deprecated": true, - "type": "integer" - }, - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "pull_number": { "required": true, "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/pulls/:pull_number/commits" - }, - "listFiles": { - "method": "GET", - "params": { - "number": { - "alias": "pull_number", - "deprecated": true, - "type": "integer" - }, - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "pull_number": { "required": true, "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/pulls/:pull_number/files" - }, - "listReviewRequests": { - "method": "GET", - "params": { - "number": { - "alias": "pull_number", - "deprecated": true, - "type": "integer" - }, - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "pull_number": { "required": true, "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/pulls/:pull_number/requested_reviewers" - }, - "listReviews": { - "method": "GET", - "params": { - "number": { - "alias": "pull_number", - "deprecated": true, - "type": "integer" - }, - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "pull_number": { "required": true, "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/pulls/:pull_number/reviews" - }, - "merge": { - "method": "PUT", - "params": { - "commit_message": { "type": "string" }, - "commit_title": { "type": "string" }, - "merge_method": { - "enum": ["merge", "squash", "rebase"], - "type": "string" - }, - "number": { - "alias": "pull_number", - "deprecated": true, - "type": "integer" - }, - "owner": { "required": true, "type": "string" }, - "pull_number": { "required": true, "type": "integer" }, - "repo": { "required": true, "type": "string" }, - "sha": { "type": "string" } - }, - "url": "/repos/:owner/:repo/pulls/:pull_number/merge" - }, - "submitReview": { - "method": "POST", - "params": { - "body": { "type": "string" }, - "event": { - "enum": ["APPROVE", "REQUEST_CHANGES", "COMMENT"], - "required": true, - "type": "string" - }, - "number": { - "alias": "pull_number", - "deprecated": true, - "type": "integer" - }, - "owner": { "required": true, "type": "string" }, - "pull_number": { "required": true, "type": "integer" }, - "repo": { "required": true, "type": "string" }, - "review_id": { "required": true, "type": "integer" } - }, - "url": "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/events" - }, - "update": { - "method": "PATCH", - "params": { - "base": { "type": "string" }, - "body": { "type": "string" }, - "maintainer_can_modify": { "type": "boolean" }, - "number": { - "alias": "pull_number", - "deprecated": true, - "type": "integer" - }, - "owner": { "required": true, "type": "string" }, - "pull_number": { "required": true, "type": "integer" }, - "repo": { "required": true, "type": "string" }, - "state": { "enum": ["open", "closed"], "type": "string" }, - "title": { "type": "string" } - }, - "url": "/repos/:owner/:repo/pulls/:pull_number" - }, - "updateBranch": { - "headers": { "accept": "application/vnd.github.lydian-preview+json" }, - "method": "PUT", - "params": { - "expected_head_sha": { "type": "string" }, - "owner": { "required": true, "type": "string" }, - "pull_number": { "required": true, "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/pulls/:pull_number/update-branch" - }, - "updateComment": { - "method": "PATCH", - "params": { - "body": { "required": true, "type": "string" }, - "comment_id": { "required": true, "type": "integer" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/pulls/comments/:comment_id" - }, - "updateReview": { - "method": "PUT", - "params": { - "body": { "required": true, "type": "string" }, - "number": { - "alias": "pull_number", - "deprecated": true, - "type": "integer" - }, - "owner": { "required": true, "type": "string" }, - "pull_number": { "required": true, "type": "integer" }, - "repo": { "required": true, "type": "string" }, - "review_id": { "required": true, "type": "integer" } - }, - "url": "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id" - } - }, - "rateLimit": { - "get": { "method": "GET", "params": {}, "url": "/rate_limit" } - }, - "reactions": { - "createForCommitComment": { - "headers": { - "accept": "application/vnd.github.squirrel-girl-preview+json" - }, - "method": "POST", - "params": { - "comment_id": { "required": true, "type": "integer" }, - "content": { - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "required": true, - "type": "string" - }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/comments/:comment_id/reactions" - }, - "createForIssue": { - "headers": { - "accept": "application/vnd.github.squirrel-girl-preview+json" - }, - "method": "POST", - "params": { - "content": { - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "required": true, - "type": "string" - }, - "issue_number": { "required": true, "type": "integer" }, - "number": { - "alias": "issue_number", - "deprecated": true, - "type": "integer" - }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/issues/:issue_number/reactions" - }, - "createForIssueComment": { - "headers": { - "accept": "application/vnd.github.squirrel-girl-preview+json" - }, - "method": "POST", - "params": { - "comment_id": { "required": true, "type": "integer" }, - "content": { - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "required": true, - "type": "string" - }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/issues/comments/:comment_id/reactions" - }, - "createForPullRequestReviewComment": { - "headers": { - "accept": "application/vnd.github.squirrel-girl-preview+json" - }, - "method": "POST", - "params": { - "comment_id": { "required": true, "type": "integer" }, - "content": { - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "required": true, - "type": "string" - }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/pulls/comments/:comment_id/reactions" - }, - "createForTeamDiscussion": { - "headers": { - "accept": "application/vnd.github.echo-preview+json,application/vnd.github.squirrel-girl-preview+json" - }, - "method": "POST", - "params": { - "content": { - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "required": true, - "type": "string" - }, - "discussion_number": { "required": true, "type": "integer" }, - "team_id": { "required": true, "type": "integer" } - }, - "url": "/teams/:team_id/discussions/:discussion_number/reactions" - }, - "createForTeamDiscussionComment": { - "headers": { - "accept": "application/vnd.github.echo-preview+json,application/vnd.github.squirrel-girl-preview+json" - }, - "method": "POST", - "params": { - "comment_number": { "required": true, "type": "integer" }, - "content": { - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "required": true, - "type": "string" - }, - "discussion_number": { "required": true, "type": "integer" }, - "team_id": { "required": true, "type": "integer" } - }, - "url": "/teams/:team_id/discussions/:discussion_number/comments/:comment_number/reactions" - }, - "delete": { - "headers": { - "accept": "application/vnd.github.echo-preview+json,application/vnd.github.squirrel-girl-preview+json" - }, - "method": "DELETE", - "params": { "reaction_id": { "required": true, "type": "integer" } }, - "url": "/reactions/:reaction_id" - }, - "listForCommitComment": { - "headers": { - "accept": "application/vnd.github.squirrel-girl-preview+json" - }, - "method": "GET", - "params": { - "comment_id": { "required": true, "type": "integer" }, - "content": { - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "type": "string" - }, - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/comments/:comment_id/reactions" - }, - "listForIssue": { - "headers": { - "accept": "application/vnd.github.squirrel-girl-preview+json" - }, - "method": "GET", - "params": { - "content": { - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "type": "string" - }, - "issue_number": { "required": true, "type": "integer" }, - "number": { - "alias": "issue_number", - "deprecated": true, - "type": "integer" - }, - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/issues/:issue_number/reactions" - }, - "listForIssueComment": { - "headers": { - "accept": "application/vnd.github.squirrel-girl-preview+json" - }, - "method": "GET", - "params": { - "comment_id": { "required": true, "type": "integer" }, - "content": { - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "type": "string" - }, - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/issues/comments/:comment_id/reactions" - }, - "listForPullRequestReviewComment": { - "headers": { - "accept": "application/vnd.github.squirrel-girl-preview+json" - }, - "method": "GET", - "params": { - "comment_id": { "required": true, "type": "integer" }, - "content": { - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "type": "string" - }, - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/pulls/comments/:comment_id/reactions" - }, - "listForTeamDiscussion": { - "headers": { - "accept": "application/vnd.github.echo-preview+json,application/vnd.github.squirrel-girl-preview+json" - }, - "method": "GET", - "params": { - "content": { - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "type": "string" - }, - "discussion_number": { "required": true, "type": "integer" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "team_id": { "required": true, "type": "integer" } - }, - "url": "/teams/:team_id/discussions/:discussion_number/reactions" - }, - "listForTeamDiscussionComment": { - "headers": { - "accept": "application/vnd.github.echo-preview+json,application/vnd.github.squirrel-girl-preview+json" - }, - "method": "GET", - "params": { - "comment_number": { "required": true, "type": "integer" }, - "content": { - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "type": "string" - }, - "discussion_number": { "required": true, "type": "integer" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "team_id": { "required": true, "type": "integer" } - }, - "url": "/teams/:team_id/discussions/:discussion_number/comments/:comment_number/reactions" - } - }, - "repos": { - "acceptInvitation": { - "method": "PATCH", - "params": { "invitation_id": { "required": true, "type": "integer" } }, - "url": "/user/repository_invitations/:invitation_id" - }, - "addCollaborator": { - "method": "PUT", - "params": { - "owner": { "required": true, "type": "string" }, - "permission": { "enum": ["pull", "push", "admin"], "type": "string" }, - "repo": { "required": true, "type": "string" }, - "username": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/collaborators/:username" - }, - "addDeployKey": { - "method": "POST", - "params": { - "key": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "read_only": { "type": "boolean" }, - "repo": { "required": true, "type": "string" }, - "title": { "type": "string" } - }, - "url": "/repos/:owner/:repo/keys" - }, - "addProtectedBranchAdminEnforcement": { - "method": "POST", - "params": { - "branch": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/branches/:branch/protection/enforce_admins" - }, - "addProtectedBranchAppRestrictions": { - "method": "POST", - "params": { - "apps": { "mapTo": "data", "required": true, "type": "string[]" }, - "branch": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/apps" - }, - "addProtectedBranchRequiredSignatures": { - "headers": { "accept": "application/vnd.github.zzzax-preview+json" }, - "method": "POST", - "params": { - "branch": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/branches/:branch/protection/required_signatures" - }, - "addProtectedBranchRequiredStatusChecksContexts": { - "method": "POST", - "params": { - "branch": { "required": true, "type": "string" }, - "contexts": { "mapTo": "data", "required": true, "type": "string[]" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts" - }, - "addProtectedBranchTeamRestrictions": { - "method": "POST", - "params": { - "branch": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "teams": { "mapTo": "data", "required": true, "type": "string[]" } - }, - "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/teams" - }, - "addProtectedBranchUserRestrictions": { - "method": "POST", - "params": { - "branch": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "users": { "mapTo": "data", "required": true, "type": "string[]" } - }, - "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/users" - }, - "checkCollaborator": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "username": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/collaborators/:username" - }, - "checkVulnerabilityAlerts": { - "headers": { "accept": "application/vnd.github.dorian-preview+json" }, - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/vulnerability-alerts" - }, - "compareCommits": { - "method": "GET", - "params": { - "base": { "required": true, "type": "string" }, - "head": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/compare/:base...:head" - }, - "createCommitComment": { - "method": "POST", - "params": { - "body": { "required": true, "type": "string" }, - "commit_sha": { "required": true, "type": "string" }, - "line": { "type": "integer" }, - "owner": { "required": true, "type": "string" }, - "path": { "type": "string" }, - "position": { "type": "integer" }, - "repo": { "required": true, "type": "string" }, - "sha": { "alias": "commit_sha", "deprecated": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/commits/:commit_sha/comments" - }, - "createDeployment": { - "method": "POST", - "params": { - "auto_merge": { "type": "boolean" }, - "description": { "type": "string" }, - "environment": { "type": "string" }, - "owner": { "required": true, "type": "string" }, - "payload": { "type": "string" }, - "production_environment": { "type": "boolean" }, - "ref": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "required_contexts": { "type": "string[]" }, - "task": { "type": "string" }, - "transient_environment": { "type": "boolean" } - }, - "url": "/repos/:owner/:repo/deployments" - }, - "createDeploymentStatus": { - "method": "POST", - "params": { - "auto_inactive": { "type": "boolean" }, - "deployment_id": { "required": true, "type": "integer" }, - "description": { "type": "string" }, - "environment": { - "enum": ["production", "staging", "qa"], - "type": "string" - }, - "environment_url": { "type": "string" }, - "log_url": { "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "state": { - "enum": [ - "error", - "failure", - "inactive", - "in_progress", - "queued", - "pending", - "success" - ], - "required": true, - "type": "string" - }, - "target_url": { "type": "string" } - }, - "url": "/repos/:owner/:repo/deployments/:deployment_id/statuses" - }, - "createDispatchEvent": { - "headers": { "accept": "application/vnd.github.everest-preview+json" }, - "method": "POST", - "params": { - "client_payload": { "type": "object" }, - "event_type": { "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/dispatches" - }, - "createFile": { - "deprecated": "octokit.repos.createFile() has been renamed to octokit.repos.createOrUpdateFile() (2019-06-07)", - "method": "PUT", - "params": { - "author": { "type": "object" }, - "author.email": { "required": true, "type": "string" }, - "author.name": { "required": true, "type": "string" }, - "branch": { "type": "string" }, - "committer": { "type": "object" }, - "committer.email": { "required": true, "type": "string" }, - "committer.name": { "required": true, "type": "string" }, - "content": { "required": true, "type": "string" }, - "message": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "path": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "sha": { "type": "string" } - }, - "url": "/repos/:owner/:repo/contents/:path" - }, - "createForAuthenticatedUser": { - "method": "POST", - "params": { - "allow_merge_commit": { "type": "boolean" }, - "allow_rebase_merge": { "type": "boolean" }, - "allow_squash_merge": { "type": "boolean" }, - "auto_init": { "type": "boolean" }, - "description": { "type": "string" }, - "gitignore_template": { "type": "string" }, - "has_issues": { "type": "boolean" }, - "has_projects": { "type": "boolean" }, - "has_wiki": { "type": "boolean" }, - "homepage": { "type": "string" }, - "is_template": { "type": "boolean" }, - "license_template": { "type": "string" }, - "name": { "required": true, "type": "string" }, - "private": { "type": "boolean" }, - "team_id": { "type": "integer" } - }, - "url": "/user/repos" - }, - "createFork": { - "method": "POST", - "params": { - "organization": { "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/forks" - }, - "createHook": { - "method": "POST", - "params": { - "active": { "type": "boolean" }, - "config": { "required": true, "type": "object" }, - "config.content_type": { "type": "string" }, - "config.insecure_ssl": { "type": "string" }, - "config.secret": { "type": "string" }, - "config.url": { "required": true, "type": "string" }, - "events": { "type": "string[]" }, - "name": { "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/hooks" - }, - "createInOrg": { - "method": "POST", - "params": { - "allow_merge_commit": { "type": "boolean" }, - "allow_rebase_merge": { "type": "boolean" }, - "allow_squash_merge": { "type": "boolean" }, - "auto_init": { "type": "boolean" }, - "description": { "type": "string" }, - "gitignore_template": { "type": "string" }, - "has_issues": { "type": "boolean" }, - "has_projects": { "type": "boolean" }, - "has_wiki": { "type": "boolean" }, - "homepage": { "type": "string" }, - "is_template": { "type": "boolean" }, - "license_template": { "type": "string" }, - "name": { "required": true, "type": "string" }, - "org": { "required": true, "type": "string" }, - "private": { "type": "boolean" }, - "team_id": { "type": "integer" } - }, - "url": "/orgs/:org/repos" - }, - "createOrUpdateFile": { - "method": "PUT", - "params": { - "author": { "type": "object" }, - "author.email": { "required": true, "type": "string" }, - "author.name": { "required": true, "type": "string" }, - "branch": { "type": "string" }, - "committer": { "type": "object" }, - "committer.email": { "required": true, "type": "string" }, - "committer.name": { "required": true, "type": "string" }, - "content": { "required": true, "type": "string" }, - "message": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "path": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "sha": { "type": "string" } - }, - "url": "/repos/:owner/:repo/contents/:path" - }, - "createRelease": { - "method": "POST", - "params": { - "body": { "type": "string" }, - "draft": { "type": "boolean" }, - "name": { "type": "string" }, - "owner": { "required": true, "type": "string" }, - "prerelease": { "type": "boolean" }, - "repo": { "required": true, "type": "string" }, - "tag_name": { "required": true, "type": "string" }, - "target_commitish": { "type": "string" } - }, - "url": "/repos/:owner/:repo/releases" - }, - "createStatus": { - "method": "POST", - "params": { - "context": { "type": "string" }, - "description": { "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "sha": { "required": true, "type": "string" }, - "state": { - "enum": ["error", "failure", "pending", "success"], - "required": true, - "type": "string" - }, - "target_url": { "type": "string" } - }, - "url": "/repos/:owner/:repo/statuses/:sha" - }, - "createUsingTemplate": { - "headers": { "accept": "application/vnd.github.baptiste-preview+json" }, - "method": "POST", - "params": { - "description": { "type": "string" }, - "name": { "required": true, "type": "string" }, - "owner": { "type": "string" }, - "private": { "type": "boolean" }, - "template_owner": { "required": true, "type": "string" }, - "template_repo": { "required": true, "type": "string" } - }, - "url": "/repos/:template_owner/:template_repo/generate" - }, - "declineInvitation": { - "method": "DELETE", - "params": { "invitation_id": { "required": true, "type": "integer" } }, - "url": "/user/repository_invitations/:invitation_id" - }, - "delete": { - "method": "DELETE", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo" - }, - "deleteCommitComment": { - "method": "DELETE", - "params": { - "comment_id": { "required": true, "type": "integer" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/comments/:comment_id" - }, - "deleteDownload": { - "method": "DELETE", - "params": { - "download_id": { "required": true, "type": "integer" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/downloads/:download_id" - }, - "deleteFile": { - "method": "DELETE", - "params": { - "author": { "type": "object" }, - "author.email": { "type": "string" }, - "author.name": { "type": "string" }, - "branch": { "type": "string" }, - "committer": { "type": "object" }, - "committer.email": { "type": "string" }, - "committer.name": { "type": "string" }, - "message": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "path": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "sha": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/contents/:path" - }, - "deleteHook": { - "method": "DELETE", - "params": { - "hook_id": { "required": true, "type": "integer" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/hooks/:hook_id" - }, - "deleteInvitation": { - "method": "DELETE", - "params": { - "invitation_id": { "required": true, "type": "integer" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/invitations/:invitation_id" - }, - "deleteRelease": { - "method": "DELETE", - "params": { - "owner": { "required": true, "type": "string" }, - "release_id": { "required": true, "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/releases/:release_id" - }, - "deleteReleaseAsset": { - "method": "DELETE", - "params": { - "asset_id": { "required": true, "type": "integer" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/releases/assets/:asset_id" - }, - "disableAutomatedSecurityFixes": { - "headers": { "accept": "application/vnd.github.london-preview+json" }, - "method": "DELETE", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/automated-security-fixes" - }, - "disablePagesSite": { - "headers": { "accept": "application/vnd.github.switcheroo-preview+json" }, - "method": "DELETE", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/pages" - }, - "disableVulnerabilityAlerts": { - "headers": { "accept": "application/vnd.github.dorian-preview+json" }, - "method": "DELETE", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/vulnerability-alerts" - }, - "enableAutomatedSecurityFixes": { - "headers": { "accept": "application/vnd.github.london-preview+json" }, - "method": "PUT", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/automated-security-fixes" - }, - "enablePagesSite": { - "headers": { "accept": "application/vnd.github.switcheroo-preview+json" }, - "method": "POST", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "source": { "type": "object" }, - "source.branch": { "enum": ["master", "gh-pages"], "type": "string" }, - "source.path": { "type": "string" } - }, - "url": "/repos/:owner/:repo/pages" - }, - "enableVulnerabilityAlerts": { - "headers": { "accept": "application/vnd.github.dorian-preview+json" }, - "method": "PUT", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/vulnerability-alerts" - }, - "get": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo" - }, - "getAppsWithAccessToProtectedBranch": { - "method": "GET", - "params": { - "branch": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/apps" - }, - "getArchiveLink": { - "method": "GET", - "params": { - "archive_format": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "ref": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/:archive_format/:ref" - }, - "getBranch": { - "method": "GET", - "params": { - "branch": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/branches/:branch" - }, - "getBranchProtection": { - "method": "GET", - "params": { - "branch": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/branches/:branch/protection" - }, - "getClones": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "per": { "enum": ["day", "week"], "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/traffic/clones" - }, - "getCodeFrequencyStats": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/stats/code_frequency" - }, - "getCollaboratorPermissionLevel": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "username": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/collaborators/:username/permission" - }, - "getCombinedStatusForRef": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "ref": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/commits/:ref/status" - }, - "getCommit": { - "method": "GET", - "params": { - "commit_sha": { "alias": "ref", "deprecated": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "ref": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "sha": { "alias": "ref", "deprecated": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/commits/:ref" - }, - "getCommitActivityStats": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/stats/commit_activity" - }, - "getCommitComment": { - "method": "GET", - "params": { - "comment_id": { "required": true, "type": "integer" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/comments/:comment_id" - }, - "getCommitRefSha": { - "deprecated": "octokit.repos.getCommitRefSha() is deprecated, see https://developer.github.com/v3/repos/commits/#get-a-single-commit", - "headers": { "accept": "application/vnd.github.v3.sha" }, - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "ref": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/commits/:ref" - }, - "getContents": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "path": { "required": true, "type": "string" }, - "ref": { "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/contents/:path" - }, - "getContributorsStats": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/stats/contributors" - }, - "getDeployKey": { - "method": "GET", - "params": { - "key_id": { "required": true, "type": "integer" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/keys/:key_id" - }, - "getDeployment": { - "method": "GET", - "params": { - "deployment_id": { "required": true, "type": "integer" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/deployments/:deployment_id" - }, - "getDeploymentStatus": { - "method": "GET", - "params": { - "deployment_id": { "required": true, "type": "integer" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "status_id": { "required": true, "type": "integer" } - }, - "url": "/repos/:owner/:repo/deployments/:deployment_id/statuses/:status_id" - }, - "getDownload": { - "method": "GET", - "params": { - "download_id": { "required": true, "type": "integer" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/downloads/:download_id" - }, - "getHook": { - "method": "GET", - "params": { - "hook_id": { "required": true, "type": "integer" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/hooks/:hook_id" - }, - "getLatestPagesBuild": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/pages/builds/latest" - }, - "getLatestRelease": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/releases/latest" - }, - "getPages": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/pages" - }, - "getPagesBuild": { - "method": "GET", - "params": { - "build_id": { "required": true, "type": "integer" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/pages/builds/:build_id" - }, - "getParticipationStats": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/stats/participation" - }, - "getProtectedBranchAdminEnforcement": { - "method": "GET", - "params": { - "branch": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/branches/:branch/protection/enforce_admins" - }, - "getProtectedBranchPullRequestReviewEnforcement": { - "method": "GET", - "params": { - "branch": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews" - }, - "getProtectedBranchRequiredSignatures": { - "headers": { "accept": "application/vnd.github.zzzax-preview+json" }, - "method": "GET", - "params": { - "branch": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/branches/:branch/protection/required_signatures" - }, - "getProtectedBranchRequiredStatusChecks": { - "method": "GET", - "params": { - "branch": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/branches/:branch/protection/required_status_checks" - }, - "getProtectedBranchRestrictions": { - "method": "GET", - "params": { - "branch": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions" - }, - "getPunchCardStats": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/stats/punch_card" - }, - "getReadme": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "ref": { "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/readme" - }, - "getRelease": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "release_id": { "required": true, "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/releases/:release_id" - }, - "getReleaseAsset": { - "method": "GET", - "params": { - "asset_id": { "required": true, "type": "integer" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/releases/assets/:asset_id" - }, - "getReleaseByTag": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "tag": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/releases/tags/:tag" - }, - "getTeamsWithAccessToProtectedBranch": { - "method": "GET", - "params": { - "branch": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/teams" - }, - "getTopPaths": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/traffic/popular/paths" - }, - "getTopReferrers": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/traffic/popular/referrers" - }, - "getUsersWithAccessToProtectedBranch": { - "method": "GET", - "params": { - "branch": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/users" - }, - "getViews": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "per": { "enum": ["day", "week"], "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/traffic/views" - }, - "list": { - "method": "GET", - "params": { - "affiliation": { "type": "string" }, - "direction": { "enum": ["asc", "desc"], "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "sort": { - "enum": ["created", "updated", "pushed", "full_name"], - "type": "string" - }, - "type": { - "enum": ["all", "owner", "public", "private", "member"], - "type": "string" - }, - "visibility": { "enum": ["all", "public", "private"], "type": "string" } - }, - "url": "/user/repos" - }, - "listAppsWithAccessToProtectedBranch": { - "deprecated": "octokit.repos.listAppsWithAccessToProtectedBranch() has been renamed to octokit.repos.getAppsWithAccessToProtectedBranch() (2019-09-13)", - "method": "GET", - "params": { - "branch": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/apps" - }, - "listAssetsForRelease": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "release_id": { "required": true, "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/releases/:release_id/assets" - }, - "listBranches": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "protected": { "type": "boolean" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/branches" - }, - "listBranchesForHeadCommit": { - "headers": { "accept": "application/vnd.github.groot-preview+json" }, - "method": "GET", - "params": { - "commit_sha": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/commits/:commit_sha/branches-where-head" - }, - "listCollaborators": { - "method": "GET", - "params": { - "affiliation": { - "enum": ["outside", "direct", "all"], - "type": "string" - }, - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/collaborators" - }, - "listCommentsForCommit": { - "method": "GET", - "params": { - "commit_sha": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "ref": { "alias": "commit_sha", "deprecated": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/commits/:commit_sha/comments" - }, - "listCommitComments": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/comments" - }, - "listCommits": { - "method": "GET", - "params": { - "author": { "type": "string" }, - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "path": { "type": "string" }, - "per_page": { "type": "integer" }, - "repo": { "required": true, "type": "string" }, - "sha": { "type": "string" }, - "since": { "type": "string" }, - "until": { "type": "string" } - }, - "url": "/repos/:owner/:repo/commits" - }, - "listContributors": { - "method": "GET", - "params": { - "anon": { "type": "string" }, - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/contributors" - }, - "listDeployKeys": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/keys" - }, - "listDeploymentStatuses": { - "method": "GET", - "params": { - "deployment_id": { "required": true, "type": "integer" }, - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/deployments/:deployment_id/statuses" - }, - "listDeployments": { - "method": "GET", - "params": { - "environment": { "type": "string" }, - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "ref": { "type": "string" }, - "repo": { "required": true, "type": "string" }, - "sha": { "type": "string" }, - "task": { "type": "string" } - }, - "url": "/repos/:owner/:repo/deployments" - }, - "listDownloads": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/downloads" - }, - "listForOrg": { - "method": "GET", - "params": { - "direction": { "enum": ["asc", "desc"], "type": "string" }, - "org": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "sort": { - "enum": ["created", "updated", "pushed", "full_name"], - "type": "string" - }, - "type": { - "enum": ["all", "public", "private", "forks", "sources", "member"], - "type": "string" - } - }, - "url": "/orgs/:org/repos" - }, - "listForUser": { - "method": "GET", - "params": { - "direction": { "enum": ["asc", "desc"], "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "sort": { - "enum": ["created", "updated", "pushed", "full_name"], - "type": "string" - }, - "type": { "enum": ["all", "owner", "member"], "type": "string" }, - "username": { "required": true, "type": "string" } - }, - "url": "/users/:username/repos" - }, - "listForks": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "repo": { "required": true, "type": "string" }, - "sort": { "enum": ["newest", "oldest", "stargazers"], "type": "string" } - }, - "url": "/repos/:owner/:repo/forks" - }, - "listHooks": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/hooks" - }, - "listInvitations": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/invitations" - }, - "listInvitationsForAuthenticatedUser": { - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" } - }, - "url": "/user/repository_invitations" - }, - "listLanguages": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/languages" - }, - "listPagesBuilds": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/pages/builds" - }, - "listProtectedBranchRequiredStatusChecksContexts": { - "method": "GET", - "params": { - "branch": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts" - }, - "listProtectedBranchTeamRestrictions": { - "deprecated": "octokit.repos.listProtectedBranchTeamRestrictions() has been renamed to octokit.repos.getTeamsWithAccessToProtectedBranch() (2019-09-09)", - "method": "GET", - "params": { - "branch": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/teams" - }, - "listProtectedBranchUserRestrictions": { - "deprecated": "octokit.repos.listProtectedBranchUserRestrictions() has been renamed to octokit.repos.getUsersWithAccessToProtectedBranch() (2019-09-09)", - "method": "GET", - "params": { - "branch": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/users" - }, - "listPublic": { - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "since": { "type": "string" } - }, - "url": "/repositories" - }, - "listPullRequestsAssociatedWithCommit": { - "headers": { "accept": "application/vnd.github.groot-preview+json" }, - "method": "GET", - "params": { - "commit_sha": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/commits/:commit_sha/pulls" - }, - "listReleases": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/releases" - }, - "listStatusesForRef": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "ref": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/commits/:ref/statuses" - }, - "listTags": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/tags" - }, - "listTeams": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/teams" - }, - "listTeamsWithAccessToProtectedBranch": { - "deprecated": "octokit.repos.listTeamsWithAccessToProtectedBranch() has been renamed to octokit.repos.getTeamsWithAccessToProtectedBranch() (2019-09-13)", - "method": "GET", - "params": { - "branch": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/teams" - }, - "listTopics": { - "headers": { "accept": "application/vnd.github.mercy-preview+json" }, - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/topics" - }, - "listUsersWithAccessToProtectedBranch": { - "deprecated": "octokit.repos.listUsersWithAccessToProtectedBranch() has been renamed to octokit.repos.getUsersWithAccessToProtectedBranch() (2019-09-13)", - "method": "GET", - "params": { - "branch": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/users" - }, - "merge": { - "method": "POST", - "params": { - "base": { "required": true, "type": "string" }, - "commit_message": { "type": "string" }, - "head": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/merges" - }, - "pingHook": { - "method": "POST", - "params": { - "hook_id": { "required": true, "type": "integer" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/hooks/:hook_id/pings" - }, - "removeBranchProtection": { - "method": "DELETE", - "params": { - "branch": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/branches/:branch/protection" - }, - "removeCollaborator": { - "method": "DELETE", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "username": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/collaborators/:username" - }, - "removeDeployKey": { - "method": "DELETE", - "params": { - "key_id": { "required": true, "type": "integer" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/keys/:key_id" - }, - "removeProtectedBranchAdminEnforcement": { - "method": "DELETE", - "params": { - "branch": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/branches/:branch/protection/enforce_admins" - }, - "removeProtectedBranchAppRestrictions": { - "method": "DELETE", - "params": { - "apps": { "mapTo": "data", "required": true, "type": "string[]" }, - "branch": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/apps" - }, - "removeProtectedBranchPullRequestReviewEnforcement": { - "method": "DELETE", - "params": { - "branch": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews" - }, - "removeProtectedBranchRequiredSignatures": { - "headers": { "accept": "application/vnd.github.zzzax-preview+json" }, - "method": "DELETE", - "params": { - "branch": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/branches/:branch/protection/required_signatures" - }, - "removeProtectedBranchRequiredStatusChecks": { - "method": "DELETE", - "params": { - "branch": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/branches/:branch/protection/required_status_checks" - }, - "removeProtectedBranchRequiredStatusChecksContexts": { - "method": "DELETE", - "params": { - "branch": { "required": true, "type": "string" }, - "contexts": { "mapTo": "data", "required": true, "type": "string[]" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts" - }, - "removeProtectedBranchRestrictions": { - "method": "DELETE", - "params": { - "branch": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions" - }, - "removeProtectedBranchTeamRestrictions": { - "method": "DELETE", - "params": { - "branch": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "teams": { "mapTo": "data", "required": true, "type": "string[]" } - }, - "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/teams" - }, - "removeProtectedBranchUserRestrictions": { - "method": "DELETE", - "params": { - "branch": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "users": { "mapTo": "data", "required": true, "type": "string[]" } - }, - "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/users" - }, - "replaceProtectedBranchAppRestrictions": { - "method": "PUT", - "params": { - "apps": { "mapTo": "data", "required": true, "type": "string[]" }, - "branch": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/apps" - }, - "replaceProtectedBranchRequiredStatusChecksContexts": { - "method": "PUT", - "params": { - "branch": { "required": true, "type": "string" }, - "contexts": { "mapTo": "data", "required": true, "type": "string[]" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts" - }, - "replaceProtectedBranchTeamRestrictions": { - "method": "PUT", - "params": { - "branch": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "teams": { "mapTo": "data", "required": true, "type": "string[]" } - }, - "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/teams" - }, - "replaceProtectedBranchUserRestrictions": { - "method": "PUT", - "params": { - "branch": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "users": { "mapTo": "data", "required": true, "type": "string[]" } - }, - "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/users" - }, - "replaceTopics": { - "headers": { "accept": "application/vnd.github.mercy-preview+json" }, - "method": "PUT", - "params": { - "names": { "required": true, "type": "string[]" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/topics" - }, - "requestPageBuild": { - "method": "POST", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/pages/builds" - }, - "retrieveCommunityProfileMetrics": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/community/profile" - }, - "testPushHook": { - "method": "POST", - "params": { - "hook_id": { "required": true, "type": "integer" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/hooks/:hook_id/tests" - }, - "transfer": { - "headers": { "accept": "application/vnd.github.nightshade-preview+json" }, - "method": "POST", - "params": { - "new_owner": { "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "team_ids": { "type": "integer[]" } - }, - "url": "/repos/:owner/:repo/transfer" - }, - "update": { - "method": "PATCH", - "params": { - "allow_merge_commit": { "type": "boolean" }, - "allow_rebase_merge": { "type": "boolean" }, - "allow_squash_merge": { "type": "boolean" }, - "archived": { "type": "boolean" }, - "default_branch": { "type": "string" }, - "description": { "type": "string" }, - "has_issues": { "type": "boolean" }, - "has_projects": { "type": "boolean" }, - "has_wiki": { "type": "boolean" }, - "homepage": { "type": "string" }, - "is_template": { "type": "boolean" }, - "name": { "type": "string" }, - "owner": { "required": true, "type": "string" }, - "private": { "type": "boolean" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo" - }, - "updateBranchProtection": { - "method": "PUT", - "params": { - "branch": { "required": true, "type": "string" }, - "enforce_admins": { - "allowNull": true, - "required": true, - "type": "boolean" - }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "required_pull_request_reviews": { - "allowNull": true, - "required": true, - "type": "object" - }, - "required_pull_request_reviews.dismiss_stale_reviews": { - "type": "boolean" - }, - "required_pull_request_reviews.dismissal_restrictions": { - "type": "object" - }, - "required_pull_request_reviews.dismissal_restrictions.teams": { - "type": "string[]" - }, - "required_pull_request_reviews.dismissal_restrictions.users": { - "type": "string[]" - }, - "required_pull_request_reviews.require_code_owner_reviews": { - "type": "boolean" - }, - "required_pull_request_reviews.required_approving_review_count": { - "type": "integer" - }, - "required_status_checks": { - "allowNull": true, - "required": true, - "type": "object" - }, - "required_status_checks.contexts": { - "required": true, - "type": "string[]" - }, - "required_status_checks.strict": { - "required": true, - "type": "boolean" - }, - "restrictions": { - "allowNull": true, - "required": true, - "type": "object" - }, - "restrictions.apps": { "type": "string[]" }, - "restrictions.teams": { "required": true, "type": "string[]" }, - "restrictions.users": { "required": true, "type": "string[]" } - }, - "url": "/repos/:owner/:repo/branches/:branch/protection" - }, - "updateCommitComment": { - "method": "PATCH", - "params": { - "body": { "required": true, "type": "string" }, - "comment_id": { "required": true, "type": "integer" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/comments/:comment_id" - }, - "updateFile": { - "deprecated": "octokit.repos.updateFile() has been renamed to octokit.repos.createOrUpdateFile() (2019-06-07)", - "method": "PUT", - "params": { - "author": { "type": "object" }, - "author.email": { "required": true, "type": "string" }, - "author.name": { "required": true, "type": "string" }, - "branch": { "type": "string" }, - "committer": { "type": "object" }, - "committer.email": { "required": true, "type": "string" }, - "committer.name": { "required": true, "type": "string" }, - "content": { "required": true, "type": "string" }, - "message": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "path": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "sha": { "type": "string" } - }, - "url": "/repos/:owner/:repo/contents/:path" - }, - "updateHook": { - "method": "PATCH", - "params": { - "active": { "type": "boolean" }, - "add_events": { "type": "string[]" }, - "config": { "type": "object" }, - "config.content_type": { "type": "string" }, - "config.insecure_ssl": { "type": "string" }, - "config.secret": { "type": "string" }, - "config.url": { "required": true, "type": "string" }, - "events": { "type": "string[]" }, - "hook_id": { "required": true, "type": "integer" }, - "owner": { "required": true, "type": "string" }, - "remove_events": { "type": "string[]" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/hooks/:hook_id" - }, - "updateInformationAboutPagesSite": { - "method": "PUT", - "params": { - "cname": { "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "source": { - "enum": ["\"gh-pages\"", "\"master\"", "\"master /docs\""], - "type": "string" - } - }, - "url": "/repos/:owner/:repo/pages" - }, - "updateInvitation": { - "method": "PATCH", - "params": { - "invitation_id": { "required": true, "type": "integer" }, - "owner": { "required": true, "type": "string" }, - "permissions": { "enum": ["read", "write", "admin"], "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/invitations/:invitation_id" - }, - "updateProtectedBranchPullRequestReviewEnforcement": { - "method": "PATCH", - "params": { - "branch": { "required": true, "type": "string" }, - "dismiss_stale_reviews": { "type": "boolean" }, - "dismissal_restrictions": { "type": "object" }, - "dismissal_restrictions.teams": { "type": "string[]" }, - "dismissal_restrictions.users": { "type": "string[]" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "require_code_owner_reviews": { "type": "boolean" }, - "required_approving_review_count": { "type": "integer" } - }, - "url": "/repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews" - }, - "updateProtectedBranchRequiredStatusChecks": { - "method": "PATCH", - "params": { - "branch": { "required": true, "type": "string" }, - "contexts": { "type": "string[]" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "strict": { "type": "boolean" } - }, - "url": "/repos/:owner/:repo/branches/:branch/protection/required_status_checks" - }, - "updateRelease": { - "method": "PATCH", - "params": { - "body": { "type": "string" }, - "draft": { "type": "boolean" }, - "name": { "type": "string" }, - "owner": { "required": true, "type": "string" }, - "prerelease": { "type": "boolean" }, - "release_id": { "required": true, "type": "integer" }, - "repo": { "required": true, "type": "string" }, - "tag_name": { "type": "string" }, - "target_commitish": { "type": "string" } - }, - "url": "/repos/:owner/:repo/releases/:release_id" - }, - "updateReleaseAsset": { - "method": "PATCH", - "params": { - "asset_id": { "required": true, "type": "integer" }, - "label": { "type": "string" }, - "name": { "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/releases/assets/:asset_id" - }, - "uploadReleaseAsset": { - "method": "POST", - "params": { - "file": { - "mapTo": "data", - "required": true, - "type": "string | object" - }, - "headers": { "required": true, "type": "object" }, - "headers.content-length": { "required": true, "type": "integer" }, - "headers.content-type": { "required": true, "type": "string" }, - "label": { "type": "string" }, - "name": { "required": true, "type": "string" }, - "url": { "required": true, "type": "string" } - }, - "url": ":url" - } - }, - "search": { - "code": { - "method": "GET", - "params": { - "order": { "enum": ["desc", "asc"], "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "q": { "required": true, "type": "string" }, - "sort": { "enum": ["indexed"], "type": "string" } - }, - "url": "/search/code" - }, - "commits": { - "headers": { "accept": "application/vnd.github.cloak-preview+json" }, - "method": "GET", - "params": { - "order": { "enum": ["desc", "asc"], "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "q": { "required": true, "type": "string" }, - "sort": { "enum": ["author-date", "committer-date"], "type": "string" } - }, - "url": "/search/commits" - }, - "issues": { - "deprecated": "octokit.search.issues() has been renamed to octokit.search.issuesAndPullRequests() (2018-12-27)", - "method": "GET", - "params": { - "order": { "enum": ["desc", "asc"], "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "q": { "required": true, "type": "string" }, - "sort": { - "enum": [ - "comments", - "reactions", - "reactions-+1", - "reactions--1", - "reactions-smile", - "reactions-thinking_face", - "reactions-heart", - "reactions-tada", - "interactions", - "created", - "updated" - ], - "type": "string" - } - }, - "url": "/search/issues" - }, - "issuesAndPullRequests": { - "method": "GET", - "params": { - "order": { "enum": ["desc", "asc"], "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "q": { "required": true, "type": "string" }, - "sort": { - "enum": [ - "comments", - "reactions", - "reactions-+1", - "reactions--1", - "reactions-smile", - "reactions-thinking_face", - "reactions-heart", - "reactions-tada", - "interactions", - "created", - "updated" - ], - "type": "string" - } - }, - "url": "/search/issues" - }, - "labels": { - "method": "GET", - "params": { - "order": { "enum": ["desc", "asc"], "type": "string" }, - "q": { "required": true, "type": "string" }, - "repository_id": { "required": true, "type": "integer" }, - "sort": { "enum": ["created", "updated"], "type": "string" } - }, - "url": "/search/labels" - }, - "repos": { - "method": "GET", - "params": { - "order": { "enum": ["desc", "asc"], "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "q": { "required": true, "type": "string" }, - "sort": { - "enum": ["stars", "forks", "help-wanted-issues", "updated"], - "type": "string" - } - }, - "url": "/search/repositories" - }, - "topics": { - "method": "GET", - "params": { "q": { "required": true, "type": "string" } }, - "url": "/search/topics" - }, - "users": { - "method": "GET", - "params": { - "order": { "enum": ["desc", "asc"], "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "q": { "required": true, "type": "string" }, - "sort": { - "enum": ["followers", "repositories", "joined"], - "type": "string" - } - }, - "url": "/search/users" - } - }, - "teams": { - "addMember": { - "deprecated": "octokit.teams.addMember() is deprecated, see https://developer.github.com/v3/teams/members/#add-team-member", - "method": "PUT", - "params": { - "team_id": { "required": true, "type": "integer" }, - "username": { "required": true, "type": "string" } - }, - "url": "/teams/:team_id/members/:username" - }, - "addOrUpdateMembership": { - "method": "PUT", - "params": { - "role": { "enum": ["member", "maintainer"], "type": "string" }, - "team_id": { "required": true, "type": "integer" }, - "username": { "required": true, "type": "string" } - }, - "url": "/teams/:team_id/memberships/:username" - }, - "addOrUpdateProject": { - "headers": { "accept": "application/vnd.github.inertia-preview+json" }, - "method": "PUT", - "params": { - "permission": { "enum": ["read", "write", "admin"], "type": "string" }, - "project_id": { "required": true, "type": "integer" }, - "team_id": { "required": true, "type": "integer" } - }, - "url": "/teams/:team_id/projects/:project_id" - }, - "addOrUpdateRepo": { - "method": "PUT", - "params": { - "owner": { "required": true, "type": "string" }, - "permission": { "enum": ["pull", "push", "admin"], "type": "string" }, - "repo": { "required": true, "type": "string" }, - "team_id": { "required": true, "type": "integer" } - }, - "url": "/teams/:team_id/repos/:owner/:repo" - }, - "checkManagesRepo": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "team_id": { "required": true, "type": "integer" } - }, - "url": "/teams/:team_id/repos/:owner/:repo" - }, - "create": { - "method": "POST", - "params": { - "description": { "type": "string" }, - "maintainers": { "type": "string[]" }, - "name": { "required": true, "type": "string" }, - "org": { "required": true, "type": "string" }, - "parent_team_id": { "type": "integer" }, - "permission": { "enum": ["pull", "push", "admin"], "type": "string" }, - "privacy": { "enum": ["secret", "closed"], "type": "string" }, - "repo_names": { "type": "string[]" } - }, - "url": "/orgs/:org/teams" - }, - "createDiscussion": { - "headers": { "accept": "application/vnd.github.echo-preview+json" }, - "method": "POST", - "params": { - "body": { "required": true, "type": "string" }, - "private": { "type": "boolean" }, - "team_id": { "required": true, "type": "integer" }, - "title": { "required": true, "type": "string" } - }, - "url": "/teams/:team_id/discussions" - }, - "createDiscussionComment": { - "headers": { "accept": "application/vnd.github.echo-preview+json" }, - "method": "POST", - "params": { - "body": { "required": true, "type": "string" }, - "discussion_number": { "required": true, "type": "integer" }, - "team_id": { "required": true, "type": "integer" } - }, - "url": "/teams/:team_id/discussions/:discussion_number/comments" - }, - "delete": { - "method": "DELETE", - "params": { "team_id": { "required": true, "type": "integer" } }, - "url": "/teams/:team_id" - }, - "deleteDiscussion": { - "headers": { "accept": "application/vnd.github.echo-preview+json" }, - "method": "DELETE", - "params": { - "discussion_number": { "required": true, "type": "integer" }, - "team_id": { "required": true, "type": "integer" } - }, - "url": "/teams/:team_id/discussions/:discussion_number" - }, - "deleteDiscussionComment": { - "headers": { "accept": "application/vnd.github.echo-preview+json" }, - "method": "DELETE", - "params": { - "comment_number": { "required": true, "type": "integer" }, - "discussion_number": { "required": true, "type": "integer" }, - "team_id": { "required": true, "type": "integer" } - }, - "url": "/teams/:team_id/discussions/:discussion_number/comments/:comment_number" - }, - "get": { - "method": "GET", - "params": { "team_id": { "required": true, "type": "integer" } }, - "url": "/teams/:team_id" - }, - "getByName": { - "method": "GET", - "params": { - "org": { "required": true, "type": "string" }, - "team_slug": { "required": true, "type": "string" } - }, - "url": "/orgs/:org/teams/:team_slug" - }, - "getDiscussion": { - "headers": { "accept": "application/vnd.github.echo-preview+json" }, - "method": "GET", - "params": { - "discussion_number": { "required": true, "type": "integer" }, - "team_id": { "required": true, "type": "integer" } - }, - "url": "/teams/:team_id/discussions/:discussion_number" - }, - "getDiscussionComment": { - "headers": { "accept": "application/vnd.github.echo-preview+json" }, - "method": "GET", - "params": { - "comment_number": { "required": true, "type": "integer" }, - "discussion_number": { "required": true, "type": "integer" }, - "team_id": { "required": true, "type": "integer" } - }, - "url": "/teams/:team_id/discussions/:discussion_number/comments/:comment_number" - }, - "getMember": { - "deprecated": "octokit.teams.getMember() is deprecated, see https://developer.github.com/v3/teams/members/#get-team-member", - "method": "GET", - "params": { - "team_id": { "required": true, "type": "integer" }, - "username": { "required": true, "type": "string" } - }, - "url": "/teams/:team_id/members/:username" - }, - "getMembership": { - "method": "GET", - "params": { - "team_id": { "required": true, "type": "integer" }, - "username": { "required": true, "type": "string" } - }, - "url": "/teams/:team_id/memberships/:username" - }, - "list": { - "method": "GET", - "params": { - "org": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" } - }, - "url": "/orgs/:org/teams" - }, - "listChild": { - "headers": { "accept": "application/vnd.github.hellcat-preview+json" }, - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "team_id": { "required": true, "type": "integer" } - }, - "url": "/teams/:team_id/teams" - }, - "listDiscussionComments": { - "headers": { "accept": "application/vnd.github.echo-preview+json" }, - "method": "GET", - "params": { - "direction": { "enum": ["asc", "desc"], "type": "string" }, - "discussion_number": { "required": true, "type": "integer" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "team_id": { "required": true, "type": "integer" } - }, - "url": "/teams/:team_id/discussions/:discussion_number/comments" - }, - "listDiscussions": { - "headers": { "accept": "application/vnd.github.echo-preview+json" }, - "method": "GET", - "params": { - "direction": { "enum": ["asc", "desc"], "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "team_id": { "required": true, "type": "integer" } - }, - "url": "/teams/:team_id/discussions" - }, - "listForAuthenticatedUser": { - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" } - }, - "url": "/user/teams" - }, - "listMembers": { - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "role": { "enum": ["member", "maintainer", "all"], "type": "string" }, - "team_id": { "required": true, "type": "integer" } - }, - "url": "/teams/:team_id/members" - }, - "listPendingInvitations": { - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "team_id": { "required": true, "type": "integer" } - }, - "url": "/teams/:team_id/invitations" - }, - "listProjects": { - "headers": { "accept": "application/vnd.github.inertia-preview+json" }, - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "team_id": { "required": true, "type": "integer" } - }, - "url": "/teams/:team_id/projects" - }, - "listRepos": { - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "team_id": { "required": true, "type": "integer" } - }, - "url": "/teams/:team_id/repos" - }, - "removeMember": { - "deprecated": "octokit.teams.removeMember() is deprecated, see https://developer.github.com/v3/teams/members/#remove-team-member", - "method": "DELETE", - "params": { - "team_id": { "required": true, "type": "integer" }, - "username": { "required": true, "type": "string" } - }, - "url": "/teams/:team_id/members/:username" - }, - "removeMembership": { - "method": "DELETE", - "params": { - "team_id": { "required": true, "type": "integer" }, - "username": { "required": true, "type": "string" } - }, - "url": "/teams/:team_id/memberships/:username" - }, - "removeProject": { - "method": "DELETE", - "params": { - "project_id": { "required": true, "type": "integer" }, - "team_id": { "required": true, "type": "integer" } - }, - "url": "/teams/:team_id/projects/:project_id" - }, - "removeRepo": { - "method": "DELETE", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "team_id": { "required": true, "type": "integer" } - }, - "url": "/teams/:team_id/repos/:owner/:repo" - }, - "reviewProject": { - "headers": { "accept": "application/vnd.github.inertia-preview+json" }, - "method": "GET", - "params": { - "project_id": { "required": true, "type": "integer" }, - "team_id": { "required": true, "type": "integer" } - }, - "url": "/teams/:team_id/projects/:project_id" - }, - "update": { - "method": "PATCH", - "params": { - "description": { "type": "string" }, - "name": { "required": true, "type": "string" }, - "parent_team_id": { "type": "integer" }, - "permission": { "enum": ["pull", "push", "admin"], "type": "string" }, - "privacy": { "enum": ["secret", "closed"], "type": "string" }, - "team_id": { "required": true, "type": "integer" } - }, - "url": "/teams/:team_id" - }, - "updateDiscussion": { - "headers": { "accept": "application/vnd.github.echo-preview+json" }, - "method": "PATCH", - "params": { - "body": { "type": "string" }, - "discussion_number": { "required": true, "type": "integer" }, - "team_id": { "required": true, "type": "integer" }, - "title": { "type": "string" } - }, - "url": "/teams/:team_id/discussions/:discussion_number" - }, - "updateDiscussionComment": { - "headers": { "accept": "application/vnd.github.echo-preview+json" }, - "method": "PATCH", - "params": { - "body": { "required": true, "type": "string" }, - "comment_number": { "required": true, "type": "integer" }, - "discussion_number": { "required": true, "type": "integer" }, - "team_id": { "required": true, "type": "integer" } - }, - "url": "/teams/:team_id/discussions/:discussion_number/comments/:comment_number" - } - }, - "users": { - "addEmails": { - "method": "POST", - "params": { "emails": { "required": true, "type": "string[]" } }, - "url": "/user/emails" - }, - "block": { - "method": "PUT", - "params": { "username": { "required": true, "type": "string" } }, - "url": "/user/blocks/:username" - }, - "checkBlocked": { - "method": "GET", - "params": { "username": { "required": true, "type": "string" } }, - "url": "/user/blocks/:username" - }, - "checkFollowing": { - "method": "GET", - "params": { "username": { "required": true, "type": "string" } }, - "url": "/user/following/:username" - }, - "checkFollowingForUser": { - "method": "GET", - "params": { - "target_user": { "required": true, "type": "string" }, - "username": { "required": true, "type": "string" } - }, - "url": "/users/:username/following/:target_user" - }, - "createGpgKey": { - "method": "POST", - "params": { "armored_public_key": { "type": "string" } }, - "url": "/user/gpg_keys" - }, - "createPublicKey": { - "method": "POST", - "params": { "key": { "type": "string" }, "title": { "type": "string" } }, - "url": "/user/keys" - }, - "deleteEmails": { - "method": "DELETE", - "params": { "emails": { "required": true, "type": "string[]" } }, - "url": "/user/emails" - }, - "deleteGpgKey": { - "method": "DELETE", - "params": { "gpg_key_id": { "required": true, "type": "integer" } }, - "url": "/user/gpg_keys/:gpg_key_id" - }, - "deletePublicKey": { - "method": "DELETE", - "params": { "key_id": { "required": true, "type": "integer" } }, - "url": "/user/keys/:key_id" - }, - "follow": { - "method": "PUT", - "params": { "username": { "required": true, "type": "string" } }, - "url": "/user/following/:username" - }, - "getAuthenticated": { "method": "GET", "params": {}, "url": "/user" }, - "getByUsername": { - "method": "GET", - "params": { "username": { "required": true, "type": "string" } }, - "url": "/users/:username" - }, - "getContextForUser": { - "headers": { "accept": "application/vnd.github.hagar-preview+json" }, - "method": "GET", - "params": { - "subject_id": { "type": "string" }, - "subject_type": { - "enum": ["organization", "repository", "issue", "pull_request"], - "type": "string" - }, - "username": { "required": true, "type": "string" } - }, - "url": "/users/:username/hovercard" - }, - "getGpgKey": { - "method": "GET", - "params": { "gpg_key_id": { "required": true, "type": "integer" } }, - "url": "/user/gpg_keys/:gpg_key_id" - }, - "getPublicKey": { - "method": "GET", - "params": { "key_id": { "required": true, "type": "integer" } }, - "url": "/user/keys/:key_id" - }, - "list": { - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "since": { "type": "string" } - }, - "url": "/users" - }, - "listBlocked": { "method": "GET", "params": {}, "url": "/user/blocks" }, - "listEmails": { - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" } - }, - "url": "/user/emails" - }, - "listFollowersForAuthenticatedUser": { - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" } - }, - "url": "/user/followers" - }, - "listFollowersForUser": { - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "username": { "required": true, "type": "string" } - }, - "url": "/users/:username/followers" - }, - "listFollowingForAuthenticatedUser": { - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" } - }, - "url": "/user/following" - }, - "listFollowingForUser": { - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "username": { "required": true, "type": "string" } - }, - "url": "/users/:username/following" - }, - "listGpgKeys": { - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" } - }, - "url": "/user/gpg_keys" - }, - "listGpgKeysForUser": { - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "username": { "required": true, "type": "string" } - }, - "url": "/users/:username/gpg_keys" - }, - "listPublicEmails": { - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" } - }, - "url": "/user/public_emails" - }, - "listPublicKeys": { - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" } - }, - "url": "/user/keys" - }, - "listPublicKeysForUser": { - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "username": { "required": true, "type": "string" } - }, - "url": "/users/:username/keys" - }, - "togglePrimaryEmailVisibility": { - "method": "PATCH", - "params": { - "email": { "required": true, "type": "string" }, - "visibility": { "required": true, "type": "string" } - }, - "url": "/user/email/visibility" - }, - "unblock": { - "method": "DELETE", - "params": { "username": { "required": true, "type": "string" } }, - "url": "/user/blocks/:username" - }, - "unfollow": { - "method": "DELETE", - "params": { "username": { "required": true, "type": "string" } }, - "url": "/user/following/:username" - }, - "updateAuthenticated": { - "method": "PATCH", - "params": { - "bio": { "type": "string" }, - "blog": { "type": "string" }, - "company": { "type": "string" }, - "email": { "type": "string" }, - "hireable": { "type": "boolean" }, - "location": { "type": "string" }, - "name": { "type": "string" } - }, - "url": "/user" - } - } -} diff --git a/node_modules/@octokit/types/.github/ISSUE_TEMPLATE/01_help.md b/node_modules/@octokit/types/.github/ISSUE_TEMPLATE/01_help.md deleted file mode 100644 index b518515..0000000 --- a/node_modules/@octokit/types/.github/ISSUE_TEMPLATE/01_help.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -name: "🆘 Help" -about: "How does this even work 🤷‍♂️" -labels: support ---- diff --git a/node_modules/@octokit/types/.github/ISSUE_TEMPLATE/02_bug.md b/node_modules/@octokit/types/.github/ISSUE_TEMPLATE/02_bug.md deleted file mode 100644 index d7e8325..0000000 --- a/node_modules/@octokit/types/.github/ISSUE_TEMPLATE/02_bug.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -name: "🐛 Bug Report" -about: "If something isn't working as expected 🤔" -labels: bug ---- - - - -**What happened?** - - - -**What did you expect to happen?** - - - -**What the problem might be** - - diff --git a/node_modules/@octokit/types/.github/ISSUE_TEMPLATE/03_feature_request.md b/node_modules/@octokit/types/.github/ISSUE_TEMPLATE/03_feature_request.md deleted file mode 100644 index 89a5481..0000000 --- a/node_modules/@octokit/types/.github/ISSUE_TEMPLATE/03_feature_request.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -name: "🧚‍♂️ Feature Request" -about: "Wouldn’t it be nice if 💭" -labels: feature ---- - - - -**What’s missing?** - - - -**Why?** - - - -**Alternatives you tried** - - diff --git a/node_modules/@octokit/types/.github/ISSUE_TEMPLATE/04_thanks.md b/node_modules/@octokit/types/.github/ISSUE_TEMPLATE/04_thanks.md deleted file mode 100644 index c67ce83..0000000 --- a/node_modules/@octokit/types/.github/ISSUE_TEMPLATE/04_thanks.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -name: "💝 Thank you" -about: "@octokit/types is awesome 🙌" -labels: thanks ---- - - - -**How do you use @octokit/types?** - - - -**What do you love about it?** - - - -**How did you learn about it?** - - diff --git a/node_modules/@octokit/types/.github/workflows/release.yml b/node_modules/@octokit/types/.github/workflows/release.yml deleted file mode 100644 index b315607..0000000 --- a/node_modules/@octokit/types/.github/workflows/release.yml +++ /dev/null @@ -1,28 +0,0 @@ -name: Release -on: - push: - branches: - - master - -jobs: - release: - name: release - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@master - - uses: actions/setup-node@v1 - with: - node-version: "12.x" - - run: npm ci - - run: npx semantic-release - env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - NPM_TOKEN: ${{ secrets.NPM_TOKEN }} - - run: npm run docs - env: - # workaround "Failed to replace env in config: ${NPM_TOKEN}" error - NPM_TOKEN: ${{ secrets.NPM_TOKEN }} - - uses: maxheld83/ghpages@master - env: - BUILD_DIR: docs/ - GH_PAT: ${{ secrets.OCTOKIT_PAT }} diff --git a/node_modules/@octokit/types/.github/workflows/routes-update.yml b/node_modules/@octokit/types/.github/workflows/routes-update.yml deleted file mode 100644 index 38d841d..0000000 --- a/node_modules/@octokit/types/.github/workflows/routes-update.yml +++ /dev/null @@ -1,39 +0,0 @@ -name: octokit/routes update -on: - repository_dispatch: - types: [octokit-routes-release] - -jobs: - update_routes: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@master - - uses: actions/setup-node@v1 - with: - node-version: "12.x" - # try checking out routes-update branch. Ignore error if it does not exist - - run: git checkout routes-update || true - - run: npm ci - - run: npm run update-endpoints - env: - VERSION: ${{ github.event.client_payload.version }} - - name: Create Pull Request - uses: gr2m/create-or-update-pull-request-action@v1.x - env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - with: - title: "🚧 GitHub REST Endpoints changed" - body: | - See what changed at https://github.com/octokit/routes/releases/latest. - - Make sure to update the commits so that the merge results in helpful release notes, see [Merging the Pull Request & releasing a new version](https://github.com/octokit/rest.js/blob/master/CONTRIBUTING.md#merging-the-pull-request--releasing-a-new-version). - - In general - - - Avoid breaking changes at all costs - - If there are no typescript or code changes, use a `docs` prefix - - If there are typescript changes but no code changes, use `fix(typescript)` prefix - - If there are code changes, use `fix` if a problem was resolved, `feat` if new endpoints / parameters were added, and `feat(deprecation)` if a method was deprecated. - branch: "routes-update" - commit-message: "WIP octokit/routes updated" - author: "Octokit Bot <33075676+octokitbot@users.noreply.github.com>" diff --git a/node_modules/@octokit/types/.github/workflows/test.yml b/node_modules/@octokit/types/.github/workflows/test.yml deleted file mode 100644 index 702220f..0000000 --- a/node_modules/@octokit/types/.github/workflows/test.yml +++ /dev/null @@ -1,19 +0,0 @@ -name: Test -on: - push: - branches: - - master - - "greenkeeper/*" - pull_request: - types: [opened, synchronize] - -jobs: - test: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@master - - uses: actions/setup-node@v1 - with: - node-version: 12 - - run: npm ci - - run: npm test diff --git a/node_modules/@octokit/types/CODE_OF_CONDUCT.md b/node_modules/@octokit/types/CODE_OF_CONDUCT.md deleted file mode 100644 index 8392e63..0000000 --- a/node_modules/@octokit/types/CODE_OF_CONDUCT.md +++ /dev/null @@ -1,75 +0,0 @@ -# Contributor Covenant Code of Conduct - -## Our Pledge - -In the interest of fostering an open and welcoming environment, we as -contributors and maintainers pledge to making participation in our project and -our community a harassment-free experience for everyone, regardless of age, body -size, disability, ethnicity, gender identity and expression, level of experience, -nationality, personal appearance, race, religion, or sexual identity and -orientation. - -## Our Standards - -Examples of behavior that contributes to creating a positive environment -include: - -- Using welcoming and inclusive language -- Being respectful of differing viewpoints and experiences -- Gracefully accepting constructive criticism -- Focusing on what is best for the community -- Showing empathy towards other community members - -Examples of unacceptable behavior by participants include: - -- The use of sexualized language or imagery and unwelcome sexual attention or - advances -- Trolling, insulting/derogatory comments, and personal or political attacks -- Public or private harassment -- Publishing others' private information, such as a physical or electronic - address, without explicit permission -- Other conduct which could reasonably be considered inappropriate in a - professional setting - -## Our Responsibilities - -Project maintainers are responsible for clarifying the standards of acceptable -behavior and are expected to take appropriate and fair corrective action in -response to any instances of unacceptable behavior. - -Project maintainers have the right and responsibility to remove, edit, or -reject comments, commits, code, wiki edits, issues, and other contributions -that are not aligned to this Code of Conduct, or to ban temporarily or -permanently any contributor for other behaviors that they deem inappropriate, -threatening, offensive, or harmful. - -## Scope - -This Code of Conduct applies both within project spaces and in public spaces -when an individual is representing the project or its community. Examples of -representing a project or community include using an official project e-mail -address, posting via an official social media account, or acting as an appointed -representative at an online or offline event. Representation of a project may be -further defined and clarified by project maintainers. - -## Enforcement - -Instances of abusive, harassing, or otherwise unacceptable behavior may be -reported by contacting the project team at opensource+octokit@github.com. All -complaints will be reviewed and investigated and will result in a response that -is deemed necessary and appropriate to the circumstances. The project team is -obligated to maintain confidentiality with regard to the reporter of an incident. -Further details of specific enforcement policies may be posted separately. - -Project maintainers who do not follow or enforce the Code of Conduct in good -faith may face temporary or permanent repercussions as determined by other -members of the project's leadership. - -## Attribution - -This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, -available at [https://contributor-covenant.org/version/1/4][version] - -[homepage]: https://contributor-covenant.org -[version]: https://contributor-covenant.org/version/1/4/ - diff --git a/node_modules/@octokit/types/CONTRIBUTING.md b/node_modules/@octokit/types/CONTRIBUTING.md deleted file mode 100644 index 6b27599..0000000 --- a/node_modules/@octokit/types/CONTRIBUTING.md +++ /dev/null @@ -1,59 +0,0 @@ -# How to contribute - -Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). -By participating in this project you agree to abide by its terms. - -## Creating an Issue - -Before you create a new Issue: - -1. Please make sure there is no [open issue](https://github.com/octokit/plugin-paginate-rest/issues?utf8=%E2%9C%93&q=is%3Aissue) yet. -2. If it is a bug report, include the steps to reproduce the issue and please create a reproducible test case on [runkit.com](https://runkit.com/). Example: https://runkit.com/gr2m/5aa034f1440b420012a6eebf -3. If it is a feature request, please share the motivation for the new feature, what alternatives you tried, and how you would implement it. -4. Please include links to the corresponding github documentation. - -## Setup the repository locally - -First, fork the repository. - -Setup the repository locally. Replace `` with the name of the account you forked to. - -```shell -git clone https://github.com//plugin-paginate-rest.js.git -cd plugin-paginate-rest.js -npm install -``` - -Run the tests before making changes to make sure the local setup is working as expected - -```shell -npm test -``` - -## Submitting the Pull Request - -- Create a new branch locally. -- Make your changes in that branch to your fork repository -- Submit a pull request from your topic branch to the master branch on the `octokit/plugin-paginate-rest.js` repository. -- Be sure to tag any issues your pull request is taking care of / contributing to. Adding "Closes #123" to a pull request description will automatically close the issue once the pull request is merged in. - -## Testing a pull request from github repo locally: - -You can install `@octokit/plugin-paginate-rest` from each pull request. Replace `[PULL REQUEST NUMBER]` - -Once you are done testing, you can revert back to the default module `@octokit/plugin-paginate-rest` from npm with `npm install @octokit/plugin-paginate-rest` - -## Merging the Pull Request & releasing a new version - -Releases are automated using [semantic-release](https://github.com/semantic-release/semantic-release). -The following commit message conventions determine which version is released: - -1. `fix: ...` or `fix(scope name): ...` prefix in subject: bumps fix version, e.g. `1.2.3` → `1.2.4` -2. `feat: ...` or `feat(scope name): ...` prefix in subject: bumps feature version, e.g. `1.2.3` → `1.3.0` -3. `BREAKING CHANGE:` in body: bumps breaking version, e.g. `1.2.3` → `2.0.0` - -Only one version number is bumped at a time, the highest version change trumps the others. -Besides publishing a new version to npm, semantic-release also creates a git tag and release -on GitHub, generates changelogs from the commit messages and puts them into the release notes. -s -If the pull request looks good but does not follow the commit conventions, use the Squash & merge button. diff --git a/node_modules/@octokit/types/README.md b/node_modules/@octokit/types/README.md index 482dae0..25b8f03 100644 --- a/node_modules/@octokit/types/README.md +++ b/node_modules/@octokit/types/README.md @@ -6,9 +6,55 @@ [![Build Status](https://github.com/octokit/types.ts/workflows/Test/badge.svg)](https://github.com/octokit/types.ts/actions?workflow=Test) [![Greenkeeper](https://badges.greenkeeper.io/octokit/types.ts.svg)](https://greenkeeper.io/) + + +- [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) + + + ## Usage -See https://octokit.github.io/types.ts for all exported types +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 "./src"; + +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 diff --git a/node_modules/@octokit/types/package.json b/node_modules/@octokit/types/package.json index 67c9120..3bf6882 100644 --- a/node_modules/@octokit/types/package.json +++ b/node_modules/@octokit/types/package.json @@ -1,30 +1,40 @@ { - "_from": "@octokit/types@^2.0.0", - "_id": "@octokit/types@2.0.2", + "_args": [ + [ + "@octokit/types@2.14.0", + "/Users/marocchino/Documents/sticky-pull-request-comment" + ] + ], + "_from": "@octokit/types@2.14.0", + "_id": "@octokit/types@2.14.0", "_inBundle": false, - "_integrity": "sha512-StASIL2lgT3TRjxv17z9pAqbnI7HGu9DrJlg3sEBFfCLaMEqp+O3IQPUF6EZtQ4xkAu2ml6kMBBCtGxjvmtmuQ==", + "_integrity": "sha512-1w2wxpN45rEXPDFeB7rGain7wcJ/aTRg8bdILITVnS0O7a4zEGELa3JmIe+jeLdekQjvZRbVfNPqS+mi5fKCKQ==", "_location": "/@octokit/types", "_phantomChildren": {}, "_requested": { - "type": "range", + "type": "version", "registry": true, - "raw": "@octokit/types@^2.0.0", + "raw": "@octokit/types@2.14.0", "name": "@octokit/types", "escapedName": "@octokit%2ftypes", "scope": "@octokit", - "rawSpec": "^2.0.0", + "rawSpec": "2.14.0", "saveSpec": null, - "fetchSpec": "^2.0.0" + "fetchSpec": "2.14.0" }, "_requiredBy": [ + "/@octokit/auth-token", "/@octokit/endpoint", + "/@octokit/graphql", + "/@octokit/plugin-paginate-rest", + "/@octokit/plugin-rest-endpoint-methods", "/@octokit/request", - "/@octokit/request-error" + "/@octokit/request-error", + "/@octokit/rest/@octokit/request-error" ], - "_resolved": "https://registry.npmjs.org/@octokit/types/-/types-2.0.2.tgz", - "_shasum": "0888497f5a664e28b0449731d5e88e19b2a74f90", - "_spec": "@octokit/types@^2.0.0", - "_where": "/Users/shim.taewon/Documents/sticky-pull-request-comment/node_modules/@octokit/request", + "_resolved": "https://registry.npmjs.org/@octokit/types/-/types-2.14.0.tgz", + "_spec": "2.14.0", + "_where": "/Users/marocchino/Documents/sticky-pull-request-comment", "author": { "name": "Gregor Martynus", "url": "https://twitter.com/gr2m" @@ -32,26 +42,28 @@ "bugs": { "url": "https://github.com/octokit/types.ts/issues" }, - "bundleDependencies": false, "dependencies": { "@types/node": ">= 8" }, - "deprecated": false, "description": "Shared TypeScript definitions for Octokit projects", "devDependencies": { + "@gimenete/type-writer": "^0.1.5", "@octokit/graphql": "^4.2.2", - "handlebars": "^4.4.5", + "handlebars": "^4.7.6", "lodash.set": "^4.3.2", "npm-run-all": "^4.1.5", - "pascal-case": "^2.0.1", - "prettier": "^1.18.2", - "semantic-release": "^15.13.24", + "pascal-case": "^3.1.1", + "prettier": "^2.0.0", + "semantic-release": "^17.0.0", "semantic-release-plugin-update-version-in-files": "^1.0.0", "sort-keys": "^4.0.0", "string-to-jsdoc-comment": "^1.0.0", - "typedoc": "^0.15.0", + "typedoc": "^0.17.0", "typescript": "^3.6.4" }, + "files": [ + "src/" + ], "homepage": "https://github.com/octokit/types.ts#readme", "keywords": [ "github", @@ -87,14 +99,14 @@ "url": "git+https://github.com/octokit/types.ts.git" }, "scripts": { - "docs": "typedoc --module commonjs --readme none --out docs src/", - "lint": "prettier --check '{src,test}/**/*' README.md package.json !src/generated/*", - "lint:fix": "prettier --write '{src,test}/**/*' README.md package.json !src/generated/*", + "docs": "typedoc --module commonjs --readme none --out docs src/ && touch docs/.nojekyll", + "lint": "prettier --check '{src,test,scripts}/**/*.{js,ts,json}' README.md package.json !src/generated/* !scripts/update-endpoints/generated/*", + "lint:fix": "prettier --write '{src,test,scripts}/**/*.{js,ts,json}' README.md package.json !src/generated/* !scripts/update-endpoints/generated/*", "pretest": "npm run -s lint", - "test": "tsc --noEmit --declaration src/index.ts", + "test": "npx tsc --noEmit --declaration --noUnusedLocals src/index.ts test.ts", "update-endpoints": "npm-run-all update-endpoints:*", "update-endpoints:fetch-json": "node scripts/update-endpoints/fetch-json", "update-endpoints:typescript": "node scripts/update-endpoints/typescript" }, - "version": "2.0.2" + "version": "2.14.0" } diff --git a/node_modules/@octokit/types/scripts/update-endpoints/fetch-json.js b/node_modules/@octokit/types/scripts/update-endpoints/fetch-json.js deleted file mode 100644 index 309a312..0000000 --- a/node_modules/@octokit/types/scripts/update-endpoints/fetch-json.js +++ /dev/null @@ -1,46 +0,0 @@ -const { writeFileSync } = require("fs"); -const path = require("path"); - -const { graphql } = require("@octokit/graphql"); -const prettier = require("prettier"); - -if (!process.env.VERSION) { - throw new Error(`VERSION environment variable must be set`); -} - -const QUERY = ` - query ($version: String) { - endpoints(version: $version) { - name - scope(format: CAMELCASE) - id(format: CAMELCASE) - method - url - parameters { - alias - allowNull - deprecated - description - enum - name - type - required - } - } - }`; - -main(); - -async function main() { - const { endpoints } = await graphql(QUERY, { - url: "https://octokit-routes-graphql-server.now.sh/", - version: process.env.VERSION - }); - - writeFileSync( - path.resolve(__dirname, "generated", "endpoints.json"), - prettier.format(JSON.stringify(endpoints), { - parser: "json" - }) - ); -} diff --git a/node_modules/@octokit/types/scripts/update-endpoints/generated/README.md b/node_modules/@octokit/types/scripts/update-endpoints/generated/README.md deleted file mode 100644 index 6beaf58..0000000 --- a/node_modules/@octokit/types/scripts/update-endpoints/generated/README.md +++ /dev/null @@ -1,3 +0,0 @@ -# DO NOT EDIT FILES IN THIS DIRECTORY - -All files are generated automatically and will be overwritten next time [octokit/routes](https://github.com/octokit/routes/) has a new release. If you find a problem, please file an issue. diff --git a/node_modules/@octokit/types/scripts/update-endpoints/generated/endpoints.json b/node_modules/@octokit/types/scripts/update-endpoints/generated/endpoints.json deleted file mode 100644 index 6c3d62a..0000000 --- a/node_modules/@octokit/types/scripts/update-endpoints/generated/endpoints.json +++ /dev/null @@ -1,25258 +0,0 @@ -[ - { - "name": "Get the authenticated GitHub App", - "scope": "apps", - "id": "getAuthenticated", - "method": "GET", - "url": "/app", - "parameters": [] - }, - { - "name": "Create a GitHub App from a manifest", - "scope": "apps", - "id": "createFromManifest", - "method": "POST", - "url": "/app-manifests/{code}/conversions", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "code parameter", - "enum": null, - "name": "code", - "type": "string", - "required": true - } - ] - }, - { - "name": "List installations", - "scope": "apps", - "id": "listInstallations", - "method": "GET", - "url": "/app/installations", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Get an installation", - "scope": "apps", - "id": "getInstallation", - "method": "GET", - "url": "/app/installations/{installation_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "installation_id parameter", - "enum": null, - "name": "installation_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Delete an installation", - "scope": "apps", - "id": "deleteInstallation", - "method": "DELETE", - "url": "/app/installations/{installation_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "installation_id parameter", - "enum": null, - "name": "installation_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Create a new installation token", - "scope": "apps", - "id": "createInstallationToken", - "method": "POST", - "url": "/app/installations/{installation_id}/access_tokens", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "installation_id parameter", - "enum": null, - "name": "installation_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The `id`s of the repositories that the installation token can access. Providing repository `id`s restricts the access of an installation token to specific repositories. You can use the \"[List repositories](https://developer.github.com/v3/apps/installations/#list-repositories)\" endpoint to get the `id` of all repositories that an installation can access. For example, you can select specific repositories when creating an installation token to restrict the number of repositories that can be cloned using the token.", - "enum": null, - "name": "repository_ids", - "type": "integer[]", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The permissions granted to the access token. The permissions object includes the permission names and their access type. For a complete list of permissions and allowable values, see \"[GitHub App permissions](https://developer.github.com/apps/building-github-apps/creating-github-apps-using-url-parameters/#github-app-permissions).\"", - "enum": null, - "name": "permissions", - "type": "object", - "required": false - } - ] - }, - { - "name": "List your grants", - "scope": "oauthAuthorizations", - "id": "listGrants", - "method": "GET", - "url": "/applications/grants", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Get a single grant", - "scope": "oauthAuthorizations", - "id": "getGrant", - "method": "GET", - "url": "/applications/grants/{grant_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "grant_id parameter", - "enum": null, - "name": "grant_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Delete a grant", - "scope": "oauthAuthorizations", - "id": "deleteGrant", - "method": "DELETE", - "url": "/applications/grants/{grant_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "grant_id parameter", - "enum": null, - "name": "grant_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Revoke a grant for an application", - "scope": "oauthAuthorizations", - "id": "revokeGrantForApplication", - "method": "DELETE", - "url": "/applications/{client_id}/grants/{access_token}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "client_id parameter", - "enum": null, - "name": "client_id", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "access_token parameter", - "enum": null, - "name": "access_token", - "type": "string", - "required": true - } - ] - }, - { - "name": "Check an authorization", - "scope": "oauthAuthorizations", - "id": "checkAuthorization", - "method": "GET", - "url": "/applications/{client_id}/tokens/{access_token}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "client_id parameter", - "enum": null, - "name": "client_id", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "access_token parameter", - "enum": null, - "name": "access_token", - "type": "string", - "required": true - } - ] - }, - { - "name": "Reset an authorization", - "scope": "oauthAuthorizations", - "id": "resetAuthorization", - "method": "POST", - "url": "/applications/{client_id}/tokens/{access_token}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "client_id parameter", - "enum": null, - "name": "client_id", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "access_token parameter", - "enum": null, - "name": "access_token", - "type": "string", - "required": true - } - ] - }, - { - "name": "Revoke an authorization for an application", - "scope": "oauthAuthorizations", - "id": "revokeAuthorizationForApplication", - "method": "DELETE", - "url": "/applications/{client_id}/tokens/{access_token}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "client_id parameter", - "enum": null, - "name": "client_id", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "access_token parameter", - "enum": null, - "name": "access_token", - "type": "string", - "required": true - } - ] - }, - { - "name": "Get a single GitHub App", - "scope": "apps", - "id": "getBySlug", - "method": "GET", - "url": "/apps/{app_slug}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "app_slug parameter", - "enum": null, - "name": "app_slug", - "type": "string", - "required": true - } - ] - }, - { - "name": "List your authorizations", - "scope": "oauthAuthorizations", - "id": "listAuthorizations", - "method": "GET", - "url": "/authorizations", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Create a new authorization", - "scope": "oauthAuthorizations", - "id": "createAuthorization", - "method": "POST", - "url": "/authorizations", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A list of scopes that this authorization is in.", - "enum": null, - "name": "scopes", - "type": "string[]", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A note to remind you what the OAuth token is for. Tokens not associated with a specific OAuth application (i.e. personal access tokens) must have a unique note.", - "enum": null, - "name": "note", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A URL to remind you what app the OAuth token is for.", - "enum": null, - "name": "note_url", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The 20 character OAuth app client key for which to create the token.", - "enum": null, - "name": "client_id", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The 40 character OAuth app client secret for which to create the token.", - "enum": null, - "name": "client_secret", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A unique string to distinguish an authorization from others created for the same client ID and user.", - "enum": null, - "name": "fingerprint", - "type": "string", - "required": false - } - ] - }, - { - "name": "Get-or-create an authorization for a specific app", - "scope": "oauthAuthorizations", - "id": "getOrCreateAuthorizationForApp", - "method": "PUT", - "url": "/authorizations/clients/{client_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "client_id parameter", - "enum": null, - "name": "client_id", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The 40 character OAuth app client secret associated with the client ID specified in the URL.", - "enum": null, - "name": "client_secret", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A list of scopes that this authorization is in.", - "enum": null, - "name": "scopes", - "type": "string[]", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A note to remind you what the OAuth token is for.", - "enum": null, - "name": "note", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A URL to remind you what app the OAuth token is for.", - "enum": null, - "name": "note_url", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A unique string to distinguish an authorization from others created for the same client and user. If provided, this API is functionally equivalent to [Get-or-create an authorization for a specific app and fingerprint](https://developer.github.com/v3/oauth_authorizations/#get-or-create-an-authorization-for-a-specific-app-and-fingerprint).", - "enum": null, - "name": "fingerprint", - "type": "string", - "required": false - } - ] - }, - { - "name": "Get-or-create an authorization for a specific app and fingerprint", - "scope": "oauthAuthorizations", - "id": "getOrCreateAuthorizationForAppAndFingerprint", - "method": "PUT", - "url": "/authorizations/clients/{client_id}/{fingerprint}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "client_id parameter", - "enum": null, - "name": "client_id", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "fingerprint parameter", - "enum": null, - "name": "fingerprint", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The 40 character OAuth app client secret associated with the client ID specified in the URL.", - "enum": null, - "name": "client_secret", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A list of scopes that this authorization is in.", - "enum": null, - "name": "scopes", - "type": "string[]", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A note to remind you what the OAuth token is for.", - "enum": null, - "name": "note", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A URL to remind you what app the OAuth token is for.", - "enum": null, - "name": "note_url", - "type": "string", - "required": false - } - ] - }, - { - "name": "Get-or-create an authorization for a specific app and fingerprint", - "scope": "oauthAuthorizations", - "id": "getOrCreateAuthorizationForAppFingerprint", - "method": "PUT", - "url": "/authorizations/clients/{client_id}/{fingerprint}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "client_id parameter", - "enum": null, - "name": "client_id", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "fingerprint parameter", - "enum": null, - "name": "fingerprint", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The 40 character OAuth app client secret associated with the client ID specified in the URL.", - "enum": null, - "name": "client_secret", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A list of scopes that this authorization is in.", - "enum": null, - "name": "scopes", - "type": "string[]", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A note to remind you what the OAuth token is for.", - "enum": null, - "name": "note", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A URL to remind you what app the OAuth token is for.", - "enum": null, - "name": "note_url", - "type": "string", - "required": false - } - ] - }, - { - "name": "Get a single authorization", - "scope": "oauthAuthorizations", - "id": "getAuthorization", - "method": "GET", - "url": "/authorizations/{authorization_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "authorization_id parameter", - "enum": null, - "name": "authorization_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Update an existing authorization", - "scope": "oauthAuthorizations", - "id": "updateAuthorization", - "method": "PATCH", - "url": "/authorizations/{authorization_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "authorization_id parameter", - "enum": null, - "name": "authorization_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Replaces the authorization scopes with these.", - "enum": null, - "name": "scopes", - "type": "string[]", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A list of scopes to add to this authorization.", - "enum": null, - "name": "add_scopes", - "type": "string[]", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A list of scopes to remove from this authorization.", - "enum": null, - "name": "remove_scopes", - "type": "string[]", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A note to remind you what the OAuth token is for. Tokens not associated with a specific OAuth application (i.e. personal access tokens) must have a unique note.", - "enum": null, - "name": "note", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A URL to remind you what app the OAuth token is for.", - "enum": null, - "name": "note_url", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A unique string to distinguish an authorization from others created for the same client ID and user.", - "enum": null, - "name": "fingerprint", - "type": "string", - "required": false - } - ] - }, - { - "name": "Delete an authorization", - "scope": "oauthAuthorizations", - "id": "deleteAuthorization", - "method": "DELETE", - "url": "/authorizations/{authorization_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "authorization_id parameter", - "enum": null, - "name": "authorization_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "List all codes of conduct", - "scope": "codesOfConduct", - "id": "listConductCodes", - "method": "GET", - "url": "/codes_of_conduct", - "parameters": [] - }, - { - "name": "Get an individual code of conduct", - "scope": "codesOfConduct", - "id": "getConductCode", - "method": "GET", - "url": "/codes_of_conduct/{key}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "key parameter", - "enum": null, - "name": "key", - "type": "string", - "required": true - } - ] - }, - { - "name": "Create a content attachment", - "scope": "apps", - "id": "createContentAttachment", - "method": "POST", - "url": "/content_references/{content_reference_id}/attachments", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "content_reference_id parameter", - "enum": null, - "name": "content_reference_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The title of the content attachment displayed in the body or comment of an issue or pull request.", - "enum": null, - "name": "title", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The body text of the content attachment displayed in the body or comment of an issue or pull request. This parameter supports markdown.", - "enum": null, - "name": "body", - "type": "string", - "required": true - } - ] - }, - { - "name": "Get", - "scope": "emojis", - "id": "get", - "method": "GET", - "url": "/emojis", - "parameters": [] - }, - { - "name": "List public events", - "scope": "activity", - "id": "listPublicEvents", - "method": "GET", - "url": "/events", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "List feeds", - "scope": "activity", - "id": "listFeeds", - "method": "GET", - "url": "/feeds", - "parameters": [] - }, - { - "name": "List the authenticated user's gists or if called anonymously, this will return all public gists", - "scope": "gists", - "id": "list", - "method": "GET", - "url": "/gists", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only gists updated at or after this time are returned.", - "enum": null, - "name": "since", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Create a gist", - "scope": "gists", - "id": "create", - "method": "POST", - "url": "/gists", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The filenames and content of each file in the gist. The keys in the `files` object represent the filename and have the type `string`.", - "enum": null, - "name": "files", - "type": "object", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The content of the file.", - "enum": null, - "name": "files.content", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A descriptive name for this gist.", - "enum": null, - "name": "description", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "When `true`, the gist will be public and available for anyone to see.", - "enum": null, - "name": "public", - "type": "boolean", - "required": false - } - ] - }, - { - "name": "List all public gists", - "scope": "gists", - "id": "listPublic", - "method": "GET", - "url": "/gists/public", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only gists updated at or after this time are returned.", - "enum": null, - "name": "since", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "List starred gists", - "scope": "gists", - "id": "listStarred", - "method": "GET", - "url": "/gists/starred", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only gists updated at or after this time are returned.", - "enum": null, - "name": "since", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Get a single gist", - "scope": "gists", - "id": "get", - "method": "GET", - "url": "/gists/{gist_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "gist_id parameter", - "enum": null, - "name": "gist_id", - "type": "string", - "required": true - } - ] - }, - { - "name": "Edit a gist", - "scope": "gists", - "id": "update", - "method": "PATCH", - "url": "/gists/{gist_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "gist_id parameter", - "enum": null, - "name": "gist_id", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A descriptive name for this gist.", - "enum": null, - "name": "description", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The filenames and content that make up this gist.", - "enum": null, - "name": "files", - "type": "object", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The updated content of the file.", - "enum": null, - "name": "files.content", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The new name for this file. To delete a file, set the value of the filename to `null`.", - "enum": null, - "name": "files.filename", - "type": "string", - "required": false - } - ] - }, - { - "name": "Delete a gist", - "scope": "gists", - "id": "delete", - "method": "DELETE", - "url": "/gists/{gist_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "gist_id parameter", - "enum": null, - "name": "gist_id", - "type": "string", - "required": true - } - ] - }, - { - "name": "List comments on a gist", - "scope": "gists", - "id": "listComments", - "method": "GET", - "url": "/gists/{gist_id}/comments", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "gist_id parameter", - "enum": null, - "name": "gist_id", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Create a comment", - "scope": "gists", - "id": "createComment", - "method": "POST", - "url": "/gists/{gist_id}/comments", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "gist_id parameter", - "enum": null, - "name": "gist_id", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The comment text.", - "enum": null, - "name": "body", - "type": "string", - "required": true - } - ] - }, - { - "name": "Get a single comment", - "scope": "gists", - "id": "getComment", - "method": "GET", - "url": "/gists/{gist_id}/comments/{comment_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "gist_id parameter", - "enum": null, - "name": "gist_id", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "comment_id parameter", - "enum": null, - "name": "comment_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Edit a comment", - "scope": "gists", - "id": "updateComment", - "method": "PATCH", - "url": "/gists/{gist_id}/comments/{comment_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "gist_id parameter", - "enum": null, - "name": "gist_id", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "comment_id parameter", - "enum": null, - "name": "comment_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The comment text.", - "enum": null, - "name": "body", - "type": "string", - "required": true - } - ] - }, - { - "name": "Delete a comment", - "scope": "gists", - "id": "deleteComment", - "method": "DELETE", - "url": "/gists/{gist_id}/comments/{comment_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "gist_id parameter", - "enum": null, - "name": "gist_id", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "comment_id parameter", - "enum": null, - "name": "comment_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "List gist commits", - "scope": "gists", - "id": "listCommits", - "method": "GET", - "url": "/gists/{gist_id}/commits", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "gist_id parameter", - "enum": null, - "name": "gist_id", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Fork a gist", - "scope": "gists", - "id": "fork", - "method": "POST", - "url": "/gists/{gist_id}/forks", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "gist_id parameter", - "enum": null, - "name": "gist_id", - "type": "string", - "required": true - } - ] - }, - { - "name": "List gist forks", - "scope": "gists", - "id": "listForks", - "method": "GET", - "url": "/gists/{gist_id}/forks", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "gist_id parameter", - "enum": null, - "name": "gist_id", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Star a gist", - "scope": "gists", - "id": "star", - "method": "PUT", - "url": "/gists/{gist_id}/star", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "gist_id parameter", - "enum": null, - "name": "gist_id", - "type": "string", - "required": true - } - ] - }, - { - "name": "Unstar a gist", - "scope": "gists", - "id": "unstar", - "method": "DELETE", - "url": "/gists/{gist_id}/star", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "gist_id parameter", - "enum": null, - "name": "gist_id", - "type": "string", - "required": true - } - ] - }, - { - "name": "Check if a gist is starred", - "scope": "gists", - "id": "checkIsStarred", - "method": "GET", - "url": "/gists/{gist_id}/star", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "gist_id parameter", - "enum": null, - "name": "gist_id", - "type": "string", - "required": true - } - ] - }, - { - "name": "Get a specific revision of a gist", - "scope": "gists", - "id": "getRevision", - "method": "GET", - "url": "/gists/{gist_id}/{sha}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "gist_id parameter", - "enum": null, - "name": "gist_id", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "sha parameter", - "enum": null, - "name": "sha", - "type": "string", - "required": true - } - ] - }, - { - "name": "Listing available templates", - "scope": "gitignore", - "id": "listTemplates", - "method": "GET", - "url": "/gitignore/templates", - "parameters": [] - }, - { - "name": "Get a single template", - "scope": "gitignore", - "id": "getTemplate", - "method": "GET", - "url": "/gitignore/templates/{name}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "name parameter", - "enum": null, - "name": "name", - "type": "string", - "required": true - } - ] - }, - { - "name": "List repositories", - "scope": "apps", - "id": "listRepos", - "method": "GET", - "url": "/installation/repositories", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "List all issues assigned to the authenticated user across all visible repositories including owned repositories, member repositories, and organization repositories", - "scope": "issues", - "id": "list", - "method": "GET", - "url": "/issues", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Indicates which sorts of issues to return. Can be one of: \n\\* `assigned`: Issues assigned to you \n\\* `created`: Issues created by you \n\\* `mentioned`: Issues mentioning you \n\\* `subscribed`: Issues you're subscribed to updates for \n\\* `all`: All issues the authenticated user can see, regardless of participation or creation", - "enum": ["assigned", "created", "mentioned", "subscribed", "all"], - "name": "filter", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.", - "enum": ["open", "closed", "all"], - "name": "state", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A list of comma separated label names. Example: `bug,ui,@high`", - "enum": null, - "name": "labels", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "What to sort results by. Can be either `created`, `updated`, `comments`.", - "enum": ["created", "updated", "comments"], - "name": "sort", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The direction of the sort. Can be either `asc` or `desc`.", - "enum": ["asc", "desc"], - "name": "direction", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Only issues updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "enum": null, - "name": "since", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Search issues", - "scope": "search", - "id": "issuesLegacy", - "method": "GET", - "url": "/legacy/issues/search/{owner}/{repository}/{state}/{keyword}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repository parameter", - "enum": null, - "name": "repository", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Indicates the state of the issues to return. Can be either `open` or `closed`.", - "enum": ["open", "closed"], - "name": "state", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The search term.", - "enum": null, - "name": "keyword", - "type": "string", - "required": true - } - ] - }, - { - "name": "Search repositories", - "scope": "search", - "id": "reposLegacy", - "method": "GET", - "url": "/legacy/repos/search/{keyword}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The search term.", - "enum": null, - "name": "keyword", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Filter results by language.", - "enum": null, - "name": "language", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The page number to fetch.", - "enum": null, - "name": "start_page", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The sort field. One of `stars`, `forks`, or `updated`. Default: results are sorted by best match.", - "enum": ["stars", "forks", "updated"], - "name": "sort", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The sort field. if `sort` param is provided. Can be either `asc` or `desc`.", - "enum": ["asc", "desc"], - "name": "order", - "type": "string", - "required": false - } - ] - }, - { - "name": "Email search", - "scope": "search", - "id": "emailLegacy", - "method": "GET", - "url": "/legacy/user/email/{email}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The email address.", - "enum": null, - "name": "email", - "type": "string", - "required": true - } - ] - }, - { - "name": "Search users", - "scope": "search", - "id": "usersLegacy", - "method": "GET", - "url": "/legacy/user/search/{keyword}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The search term.", - "enum": null, - "name": "keyword", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The page number to fetch.", - "enum": null, - "name": "start_page", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The sort field. One of `stars`, `forks`, or `updated`. Default: results are sorted by best match.", - "enum": ["stars", "forks", "updated"], - "name": "sort", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The sort field. if `sort` param is provided. Can be either `asc` or `desc`.", - "enum": ["asc", "desc"], - "name": "order", - "type": "string", - "required": false - } - ] - }, - { - "name": "List commonly used licenses", - "scope": "licenses", - "id": "listCommonlyUsed", - "method": "GET", - "url": "/licenses", - "parameters": [] - }, - { - "name": "List commonly used licenses", - "scope": "licenses", - "id": "list", - "method": "GET", - "url": "/licenses", - "parameters": [] - }, - { - "name": "Get an individual license", - "scope": "licenses", - "id": "get", - "method": "GET", - "url": "/licenses/{license}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "license parameter", - "enum": null, - "name": "license", - "type": "string", - "required": true - } - ] - }, - { - "name": "Render an arbitrary Markdown document", - "scope": "markdown", - "id": "render", - "method": "POST", - "url": "/markdown", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The Markdown text to render in HTML. Markdown content must be 400 KB or less.", - "enum": null, - "name": "text", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The rendering mode. Can be either: \n\\* `markdown` to render a document in plain Markdown, just like README.md files are rendered. \n\\* `gfm` to render a document in [GitHub Flavored Markdown](https://github.github.com/gfm/), which creates links for user mentions as well as references to SHA-1 hashes, issues, and pull requests.", - "enum": ["markdown", "gfm"], - "name": "mode", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The repository context to use when creating references in `gfm` mode. Omit this parameter when using `markdown` mode.", - "enum": null, - "name": "context", - "type": "string", - "required": false - } - ] - }, - { - "name": "Render a Markdown document in raw mode", - "scope": "markdown", - "id": "renderRaw", - "method": "POST", - "url": "/markdown/raw", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "data parameter", - "enum": null, - "name": "data", - "type": "string", - "required": true - } - ] - }, - { - "name": "Check if a GitHub account is associated with any Marketplace listing", - "scope": "apps", - "id": "checkAccountIsAssociatedWithAny", - "method": "GET", - "url": "/marketplace_listing/accounts/{account_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "account_id parameter", - "enum": null, - "name": "account_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "List all plans for your Marketplace listing", - "scope": "apps", - "id": "listPlans", - "method": "GET", - "url": "/marketplace_listing/plans", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "List all GitHub accounts (user or organization) on a specific plan", - "scope": "apps", - "id": "listAccountsUserOrOrgOnPlan", - "method": "GET", - "url": "/marketplace_listing/plans/{plan_id}/accounts", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "plan_id parameter", - "enum": null, - "name": "plan_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Sorts the GitHub accounts by the date they were created or last updated. Can be one of `created` or `updated`.", - "enum": ["created", "updated"], - "name": "sort", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "To return the oldest accounts first, set to `asc`. Can be one of `asc` or `desc`. Ignored without the `sort` parameter.", - "enum": ["asc", "desc"], - "name": "direction", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Check if a GitHub account is associated with any Marketplace listing (stubbed)", - "scope": "apps", - "id": "checkAccountIsAssociatedWithAnyStubbed", - "method": "GET", - "url": "/marketplace_listing/stubbed/accounts/{account_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "account_id parameter", - "enum": null, - "name": "account_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "List all plans for your Marketplace listing (stubbed)", - "scope": "apps", - "id": "listPlansStubbed", - "method": "GET", - "url": "/marketplace_listing/stubbed/plans", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "List all GitHub accounts (user or organization) on a specific plan (stubbed)", - "scope": "apps", - "id": "listAccountsUserOrOrgOnPlanStubbed", - "method": "GET", - "url": "/marketplace_listing/stubbed/plans/{plan_id}/accounts", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "plan_id parameter", - "enum": null, - "name": "plan_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Sorts the GitHub accounts by the date they were created or last updated. Can be one of `created` or `updated`.", - "enum": ["created", "updated"], - "name": "sort", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "To return the oldest accounts first, set to `asc`. Can be one of `asc` or `desc`. Ignored without the `sort` parameter.", - "enum": ["asc", "desc"], - "name": "direction", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Get", - "scope": "meta", - "id": "get", - "method": "GET", - "url": "/meta", - "parameters": [] - }, - { - "name": "List public events for a network of repositories", - "scope": "activity", - "id": "listPublicEventsForRepoNetwork", - "method": "GET", - "url": "/networks/{owner}/{repo}/events", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "List your notifications", - "scope": "activity", - "id": "listNotifications", - "method": "GET", - "url": "/notifications", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "If `true`, show notifications marked as read.", - "enum": null, - "name": "all", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "If `true`, only shows notifications in which the user is directly participating or mentioned.", - "enum": null, - "name": "participating", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "enum": null, - "name": "since", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "enum": null, - "name": "before", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Mark as read", - "scope": "activity", - "id": "markAsRead", - "method": "PUT", - "url": "/notifications", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Describes the last point that notifications were checked. Anything updated since this time will not be updated. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp.", - "enum": null, - "name": "last_read_at", - "type": "string", - "required": false - } - ] - }, - { - "name": "View a single thread", - "scope": "activity", - "id": "getThread", - "method": "GET", - "url": "/notifications/threads/{thread_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "thread_id parameter", - "enum": null, - "name": "thread_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Mark a thread as read", - "scope": "activity", - "id": "markThreadAsRead", - "method": "PATCH", - "url": "/notifications/threads/{thread_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "thread_id parameter", - "enum": null, - "name": "thread_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Get a thread subscription", - "scope": "activity", - "id": "getThreadSubscription", - "method": "GET", - "url": "/notifications/threads/{thread_id}/subscription", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "thread_id parameter", - "enum": null, - "name": "thread_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Set a thread subscription", - "scope": "activity", - "id": "setThreadSubscription", - "method": "PUT", - "url": "/notifications/threads/{thread_id}/subscription", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "thread_id parameter", - "enum": null, - "name": "thread_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Unsubscribes and subscribes you to a conversation. Set `ignored` to `true` to block all notifications from this thread.", - "enum": null, - "name": "ignored", - "type": "boolean", - "required": false - } - ] - }, - { - "name": "Delete a thread subscription", - "scope": "activity", - "id": "deleteThreadSubscription", - "method": "DELETE", - "url": "/notifications/threads/{thread_id}/subscription", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "thread_id parameter", - "enum": null, - "name": "thread_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "List all organizations", - "scope": "orgs", - "id": "list", - "method": "GET", - "url": "/organizations", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The integer ID of the last Organization that you've seen.", - "enum": null, - "name": "since", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Get an organization", - "scope": "orgs", - "id": "get", - "method": "GET", - "url": "/orgs/{org}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - } - ] - }, - { - "name": "Edit an organization", - "scope": "orgs", - "id": "update", - "method": "PATCH", - "url": "/orgs/{org}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Billing email address. This address is not publicized.", - "enum": null, - "name": "billing_email", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The company name.", - "enum": null, - "name": "company", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The publicly visible email address.", - "enum": null, - "name": "email", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The location.", - "enum": null, - "name": "location", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The shorthand name of the company.", - "enum": null, - "name": "name", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The description of the company.", - "enum": null, - "name": "description", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Toggles whether organization projects are enabled for the organization.", - "enum": null, - "name": "has_organization_projects", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Toggles whether repository projects are enabled for repositories that belong to the organization.", - "enum": null, - "name": "has_repository_projects", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Default permission level members have for organization repositories: \n\\* `read` - can pull, but not push to or administer this repository. \n\\* `write` - can pull and push, but not administer this repository. \n\\* `admin` - can pull, push, and administer this repository. \n\\* `none` - no permissions granted by default.", - "enum": ["read", "write", "admin", "none"], - "name": "default_repository_permission", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Toggles the ability of non-admin organization members to create repositories. Can be one of: \n\\* `true` - all organization members can create repositories. \n\\* `false` - only admin members can create repositories. \nDefault: `true` \n**Note:** Another parameter can override the this parameter. See [this note](https://developer.github.com/v3/orgs/#members_can_create_repositories) for details. **Note:** Another parameter can override the this parameter. See [this note](https://developer.github.com/v3/orgs/#members_can_create_repositories) for details.", - "enum": null, - "name": "members_can_create_repositories", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Specifies which types of repositories non-admin organization members can create. Can be one of: \n\\* `all` - all organization members can create public and private repositories. \n\\* `private` - members can create private repositories. This option is only available to repositories that are part of an organization on [GitHub Business Cloud](https://github.com/pricing/business-cloud). \n\\* `none` - only admin members can create repositories. \n**Note:** Using this parameter will override values set in `members_can_create_repositories`. See [this note](https://developer.github.com/v3/orgs/#members_can_create_repositories) for details.", - "enum": ["all", "private", "none"], - "name": "members_allowed_repository_creation_type", - "type": "string", - "required": false - } - ] - }, - { - "name": "List blocked users", - "scope": "orgs", - "id": "listBlockedUsers", - "method": "GET", - "url": "/orgs/{org}/blocks", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - } - ] - }, - { - "name": "Check whether a user is blocked from an organization", - "scope": "orgs", - "id": "checkBlockedUser", - "method": "GET", - "url": "/orgs/{org}/blocks/{username}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - } - ] - }, - { - "name": "Block a user", - "scope": "orgs", - "id": "blockUser", - "method": "PUT", - "url": "/orgs/{org}/blocks/{username}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - } - ] - }, - { - "name": "Unblock a user", - "scope": "orgs", - "id": "unblockUser", - "method": "DELETE", - "url": "/orgs/{org}/blocks/{username}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - } - ] - }, - { - "name": "List credential authorizations for an organization", - "scope": "orgs", - "id": "listCredentialAuthorizations", - "method": "GET", - "url": "/orgs/{org}/credential-authorizations", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - } - ] - }, - { - "name": "Remove a credential authorization for an organization", - "scope": "orgs", - "id": "removeCredentialAuthorization", - "method": "DELETE", - "url": "/orgs/{org}/credential-authorizations/{credential_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "credential_id parameter", - "enum": null, - "name": "credential_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "List public events for an organization", - "scope": "activity", - "id": "listPublicEventsForOrg", - "method": "GET", - "url": "/orgs/{org}/events", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "List hooks", - "scope": "orgs", - "id": "listHooks", - "method": "GET", - "url": "/orgs/{org}/hooks", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Create a hook", - "scope": "orgs", - "id": "createHook", - "method": "POST", - "url": "/orgs/{org}/hooks", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Must be passed as \"web\".", - "enum": null, - "name": "name", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/v3/orgs/hooks/#create-hook-config-params).", - "enum": null, - "name": "config", - "type": "object", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The URL to which the payloads will be delivered.", - "enum": null, - "name": "config.url", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "enum": null, - "name": "config.content_type", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://developer.github.com/webhooks/#delivery-headers) header.", - "enum": null, - "name": "config.secret", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "enum": null, - "name": "config.insecure_ssl", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Determines what [events](https://developer.github.com/v3/activity/events/types/) the hook is triggered for.", - "enum": null, - "name": "events", - "type": "string[]", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", - "enum": null, - "name": "active", - "type": "boolean", - "required": false - } - ] - }, - { - "name": "Get single hook", - "scope": "orgs", - "id": "getHook", - "method": "GET", - "url": "/orgs/{org}/hooks/{hook_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "hook_id parameter", - "enum": null, - "name": "hook_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Edit a hook", - "scope": "orgs", - "id": "updateHook", - "method": "PATCH", - "url": "/orgs/{org}/hooks/{hook_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "hook_id parameter", - "enum": null, - "name": "hook_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/v3/orgs/hooks/#update-hook-config-params).", - "enum": null, - "name": "config", - "type": "object", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The URL to which the payloads will be delivered.", - "enum": null, - "name": "config.url", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "enum": null, - "name": "config.content_type", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://developer.github.com/webhooks/#delivery-headers) header.", - "enum": null, - "name": "config.secret", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "enum": null, - "name": "config.insecure_ssl", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Determines what [events](https://developer.github.com/v3/activity/events/types/) the hook is triggered for.", - "enum": null, - "name": "events", - "type": "string[]", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", - "enum": null, - "name": "active", - "type": "boolean", - "required": false - } - ] - }, - { - "name": "Delete a hook", - "scope": "orgs", - "id": "deleteHook", - "method": "DELETE", - "url": "/orgs/{org}/hooks/{hook_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "hook_id parameter", - "enum": null, - "name": "hook_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Ping a hook", - "scope": "orgs", - "id": "pingHook", - "method": "POST", - "url": "/orgs/{org}/hooks/{hook_id}/pings", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "hook_id parameter", - "enum": null, - "name": "hook_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Get an organization installation", - "scope": "apps", - "id": "getOrgInstallation", - "method": "GET", - "url": "/orgs/{org}/installation", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - } - ] - }, - { - "name": "Get an organization installation", - "scope": "apps", - "id": "findOrgInstallation", - "method": "GET", - "url": "/orgs/{org}/installation", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - } - ] - }, - { - "name": "Get interaction restrictions for an organization", - "scope": "interactions", - "id": "getRestrictionsForOrg", - "method": "GET", - "url": "/orgs/{org}/interaction-limits", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - } - ] - }, - { - "name": "Add or update interaction restrictions for an organization", - "scope": "interactions", - "id": "addOrUpdateRestrictionsForOrg", - "method": "PUT", - "url": "/orgs/{org}/interaction-limits", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Specifies the group of GitHub users who can comment, open issues, or create pull requests in public repositories for the given organization. Must be one of: `existing_users`, `contributors_only`, or `collaborators_only`.", - "enum": ["existing_users", "contributors_only", "collaborators_only"], - "name": "limit", - "type": "string", - "required": true - } - ] - }, - { - "name": "Remove interaction restrictions for an organization", - "scope": "interactions", - "id": "removeRestrictionsForOrg", - "method": "DELETE", - "url": "/orgs/{org}/interaction-limits", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - } - ] - }, - { - "name": "List pending organization invitations", - "scope": "orgs", - "id": "listPendingInvitations", - "method": "GET", - "url": "/orgs/{org}/invitations", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Create organization invitation", - "scope": "orgs", - "id": "createInvitation", - "method": "POST", - "url": "/orgs/{org}/invitations", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "**Required unless you provide `email`**. GitHub user ID for the person you are inviting.", - "enum": null, - "name": "invitee_id", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "**Required unless you provide `invitee_id`**. Email address of the person you are inviting, which can be an existing GitHub user.", - "enum": null, - "name": "email", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Specify role for new member. Can be one of: \n\\* `admin` - Organization owners with full administrative rights to the organization and complete access to all repositories and teams. \n\\* `direct_member` - Non-owner organization members with ability to see other members and join teams by invitation. \n\\* `billing_manager` - Non-owner organization members with ability to manage the billing settings of your organization.", - "enum": ["admin", "direct_member", "billing_manager"], - "name": "role", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Specify IDs for the teams you want to invite new members to.", - "enum": null, - "name": "team_ids", - "type": "integer[]", - "required": false - } - ] - }, - { - "name": "List organization invitation teams", - "scope": "orgs", - "id": "listInvitationTeams", - "method": "GET", - "url": "/orgs/{org}/invitations/{invitation_id}/teams", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "invitation_id parameter", - "enum": null, - "name": "invitation_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "List all issues for a given organization assigned to the authenticated user", - "scope": "issues", - "id": "listForOrg", - "method": "GET", - "url": "/orgs/{org}/issues", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Indicates which sorts of issues to return. Can be one of: \n\\* `assigned`: Issues assigned to you \n\\* `created`: Issues created by you \n\\* `mentioned`: Issues mentioning you \n\\* `subscribed`: Issues you're subscribed to updates for \n\\* `all`: All issues the authenticated user can see, regardless of participation or creation", - "enum": ["assigned", "created", "mentioned", "subscribed", "all"], - "name": "filter", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.", - "enum": ["open", "closed", "all"], - "name": "state", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A list of comma separated label names. Example: `bug,ui,@high`", - "enum": null, - "name": "labels", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "What to sort results by. Can be either `created`, `updated`, `comments`.", - "enum": ["created", "updated", "comments"], - "name": "sort", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The direction of the sort. Can be either `asc` or `desc`.", - "enum": ["asc", "desc"], - "name": "direction", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Only issues updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "enum": null, - "name": "since", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Members list", - "scope": "orgs", - "id": "listMembers", - "method": "GET", - "url": "/orgs/{org}/members", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Filter members returned in the list. Can be one of: \n\\* `2fa_disabled` - Members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled. Available for organization owners. \n\\* `all` - All members the authenticated user can see.", - "enum": ["2fa_disabled", "all"], - "name": "filter", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Filter members returned by their role. Can be one of: \n\\* `all` - All members of the organization, regardless of role. \n\\* `admin` - Organization owners. \n\\* `member` - Non-owner organization members.", - "enum": ["all", "admin", "member"], - "name": "role", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Check membership", - "scope": "orgs", - "id": "checkMembership", - "method": "GET", - "url": "/orgs/{org}/members/{username}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - } - ] - }, - { - "name": "Remove a member", - "scope": "orgs", - "id": "removeMember", - "method": "DELETE", - "url": "/orgs/{org}/members/{username}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - } - ] - }, - { - "name": "Get organization membership", - "scope": "orgs", - "id": "getMembership", - "method": "GET", - "url": "/orgs/{org}/memberships/{username}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - } - ] - }, - { - "name": "Add or update organization membership", - "scope": "orgs", - "id": "addOrUpdateMembership", - "method": "PUT", - "url": "/orgs/{org}/memberships/{username}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The role to give the user in the organization. Can be one of: \n\\* `admin` - The user will become an owner of the organization. \n\\* `member` - The user will become a non-owner member of the organization.", - "enum": ["admin", "member"], - "name": "role", - "type": "string", - "required": false - } - ] - }, - { - "name": "Remove organization membership", - "scope": "orgs", - "id": "removeMembership", - "method": "DELETE", - "url": "/orgs/{org}/memberships/{username}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - } - ] - }, - { - "name": "Start an organization migration", - "scope": "migrations", - "id": "startForOrg", - "method": "POST", - "url": "/orgs/{org}/migrations", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A list of arrays indicating which repositories should be migrated.", - "enum": null, - "name": "repositories", - "type": "string[]", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Indicates whether repositories should be locked (to prevent manipulation) while migrating data.", - "enum": null, - "name": "lock_repositories", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Indicates whether attachments should be excluded from the migration (to reduce migration archive file size).", - "enum": null, - "name": "exclude_attachments", - "type": "boolean", - "required": false - } - ] - }, - { - "name": "Get a list of organization migrations", - "scope": "migrations", - "id": "listForOrg", - "method": "GET", - "url": "/orgs/{org}/migrations", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Get the status of an organization migration", - "scope": "migrations", - "id": "getStatusForOrg", - "method": "GET", - "url": "/orgs/{org}/migrations/{migration_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "migration_id parameter", - "enum": null, - "name": "migration_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Download an organization migration archive", - "scope": "migrations", - "id": "getArchiveForOrg", - "method": "GET", - "url": "/orgs/{org}/migrations/{migration_id}/archive", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "migration_id parameter", - "enum": null, - "name": "migration_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Delete an organization migration archive", - "scope": "migrations", - "id": "deleteArchiveForOrg", - "method": "DELETE", - "url": "/orgs/{org}/migrations/{migration_id}/archive", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "migration_id parameter", - "enum": null, - "name": "migration_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Unlock an organization repository", - "scope": "migrations", - "id": "unlockRepoForOrg", - "method": "DELETE", - "url": "/orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "migration_id parameter", - "enum": null, - "name": "migration_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo_name parameter", - "enum": null, - "name": "repo_name", - "type": "string", - "required": true - } - ] - }, - { - "name": "List outside collaborators", - "scope": "orgs", - "id": "listOutsideCollaborators", - "method": "GET", - "url": "/orgs/{org}/outside_collaborators", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Filter the list of outside collaborators. Can be one of: \n\\* `2fa_disabled`: Outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled. \n\\* `all`: All outside collaborators.", - "enum": ["2fa_disabled", "all"], - "name": "filter", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Remove outside collaborator", - "scope": "orgs", - "id": "removeOutsideCollaborator", - "method": "DELETE", - "url": "/orgs/{org}/outside_collaborators/{username}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - } - ] - }, - { - "name": "Convert member to outside collaborator", - "scope": "orgs", - "id": "convertMemberToOutsideCollaborator", - "method": "PUT", - "url": "/orgs/{org}/outside_collaborators/{username}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - } - ] - }, - { - "name": "List organization projects", - "scope": "projects", - "id": "listForOrg", - "method": "GET", - "url": "/orgs/{org}/projects", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`.", - "enum": ["open", "closed", "all"], - "name": "state", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Create an organization project", - "scope": "projects", - "id": "createForOrg", - "method": "POST", - "url": "/orgs/{org}/projects", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The name of the project.", - "enum": null, - "name": "name", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The description of the project.", - "enum": null, - "name": "body", - "type": "string", - "required": false - } - ] - }, - { - "name": "Public members list", - "scope": "orgs", - "id": "listPublicMembers", - "method": "GET", - "url": "/orgs/{org}/public_members", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Check public membership", - "scope": "orgs", - "id": "checkPublicMembership", - "method": "GET", - "url": "/orgs/{org}/public_members/{username}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - } - ] - }, - { - "name": "Publicize a user's membership", - "scope": "orgs", - "id": "publicizeMembership", - "method": "PUT", - "url": "/orgs/{org}/public_members/{username}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - } - ] - }, - { - "name": "Conceal a user's membership", - "scope": "orgs", - "id": "concealMembership", - "method": "DELETE", - "url": "/orgs/{org}/public_members/{username}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - } - ] - }, - { - "name": "List organization repositories", - "scope": "repos", - "id": "listForOrg", - "method": "GET", - "url": "/orgs/{org}/repos", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`.", - "enum": ["all", "public", "private", "forks", "sources", "member"], - "name": "type", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Can be one of `created`, `updated`, `pushed`, `full_name`.", - "enum": ["created", "updated", "pushed", "full_name"], - "name": "sort", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Can be one of `asc` or `desc`. Default: when using `full_name`: `asc`, otherwise `desc`", - "enum": ["asc", "desc"], - "name": "direction", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Creates a new repository in the specified organization", - "scope": "repos", - "id": "createInOrg", - "method": "POST", - "url": "/orgs/{org}/repos", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The name of the repository.", - "enum": null, - "name": "name", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A short description of the repository.", - "enum": null, - "name": "description", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A URL with more information about the repository.", - "enum": null, - "name": "homepage", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Either `true` to create a private repository or `false` to create a public one. Creating private repositories requires a paid GitHub account.", - "enum": null, - "name": "private", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Either `true` to enable issues for this repository or `false` to disable them.", - "enum": null, - "name": "has_issues", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error.", - "enum": null, - "name": "has_projects", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Either `true` to enable the wiki for this repository or `false` to disable it.", - "enum": null, - "name": "has_wiki", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Either `true` to make this repo available as a template repository or `false` to prevent it.", - "enum": null, - "name": "is_template", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.", - "enum": null, - "name": "team_id", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Pass `true` to create an initial commit with empty README.", - "enum": null, - "name": "auto_init", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Desired language or platform [.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, \"Haskell\".", - "enum": null, - "name": "gitignore_template", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://help.github.com/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, \"mit\" or \"mpl-2.0\".", - "enum": null, - "name": "license_template", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", - "enum": null, - "name": "allow_squash_merge", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.", - "enum": null, - "name": "allow_merge_commit", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", - "enum": null, - "name": "allow_rebase_merge", - "type": "boolean", - "required": false - } - ] - }, - { - "name": "List IdP groups in an organization", - "scope": "teams", - "id": "listIdPGroupsForOrg", - "method": "GET", - "url": "/orgs/{org}/team-sync/groups", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "List teams", - "scope": "teams", - "id": "list", - "method": "GET", - "url": "/orgs/{org}/teams", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Create team", - "scope": "teams", - "id": "create", - "method": "POST", - "url": "/orgs/{org}/teams", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The name of the team.", - "enum": null, - "name": "name", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The description of the team.", - "enum": null, - "name": "description", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The logins of organization members to add as maintainers of the team.", - "enum": null, - "name": "maintainers", - "type": "string[]", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The full name (e.g., \"organization-name/repository-name\") of repositories to add the team to.", - "enum": null, - "name": "repo_names", - "type": "string[]", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The level of privacy this team should have. The options are: \n**For a non-nested team:** \n\\* `secret` - only visible to organization owners and members of this team. \n\\* `closed` - visible to all members of this organization. \nDefault: `secret` \n**For a parent or child team:** \n\\* `closed` - visible to all members of this organization. \nDefault for child team: `closed` \n**Note**: You must pass the `hellcat-preview` media type to set privacy default to `closed` for child teams.", - "enum": ["secret", "closed"], - "name": "privacy", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified. Can be one of: \n\\* `pull` - team members can pull, but not push to or administer newly-added repositories. \n\\* `push` - team members can pull and push, but not administer newly-added repositories. \n\\* `admin` - team members can pull, push and administer newly-added repositories.", - "enum": ["pull", "push", "admin"], - "name": "permission", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The ID of a team to set as the parent team. **Note**: You must pass the `hellcat-preview` media type to use this parameter.", - "enum": null, - "name": "parent_team_id", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Get team by name", - "scope": "teams", - "id": "getByName", - "method": "GET", - "url": "/orgs/{org}/teams/{team_slug}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "team_slug parameter", - "enum": null, - "name": "team_slug", - "type": "string", - "required": true - } - ] - }, - { - "name": "Get a project card", - "scope": "projects", - "id": "getCard", - "method": "GET", - "url": "/projects/columns/cards/{card_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "card_id parameter", - "enum": null, - "name": "card_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Update a project card", - "scope": "projects", - "id": "updateCard", - "method": "PATCH", - "url": "/projects/columns/cards/{card_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "card_id parameter", - "enum": null, - "name": "card_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The card's note content. Only valid for cards without another type of content, so this cannot be specified if the card already has a `content_id` and `content_type`.", - "enum": null, - "name": "note", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Use `true` to archive a project card. Specify `false` if you need to restore a previously archived project card.", - "enum": null, - "name": "archived", - "type": "boolean", - "required": false - } - ] - }, - { - "name": "Delete a project card", - "scope": "projects", - "id": "deleteCard", - "method": "DELETE", - "url": "/projects/columns/cards/{card_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "card_id parameter", - "enum": null, - "name": "card_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Move a project card", - "scope": "projects", - "id": "moveCard", - "method": "POST", - "url": "/projects/columns/cards/{card_id}/moves", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "card_id parameter", - "enum": null, - "name": "card_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Can be one of `top`, `bottom`, or `after:`, where `` is the `id` value of a card in the same column, or in the new column specified by `column_id`.", - "enum": null, - "name": "position", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The `id` value of a column in the same project.", - "enum": null, - "name": "column_id", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Get a project column", - "scope": "projects", - "id": "getColumn", - "method": "GET", - "url": "/projects/columns/{column_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "column_id parameter", - "enum": null, - "name": "column_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Update a project column", - "scope": "projects", - "id": "updateColumn", - "method": "PATCH", - "url": "/projects/columns/{column_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "column_id parameter", - "enum": null, - "name": "column_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The new name of the column.", - "enum": null, - "name": "name", - "type": "string", - "required": true - } - ] - }, - { - "name": "Delete a project column", - "scope": "projects", - "id": "deleteColumn", - "method": "DELETE", - "url": "/projects/columns/{column_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "column_id parameter", - "enum": null, - "name": "column_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "List project cards", - "scope": "projects", - "id": "listCards", - "method": "GET", - "url": "/projects/columns/{column_id}/cards", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "column_id parameter", - "enum": null, - "name": "column_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Filters the project cards that are returned by the card's state. Can be one of `all`,`archived`, or `not_archived`.", - "enum": ["all", "archived", "not_archived"], - "name": "archived_state", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Create a project card", - "scope": "projects", - "id": "createCard", - "method": "POST", - "url": "/projects/columns/{column_id}/cards", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "column_id parameter", - "enum": null, - "name": "column_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The card's note content. Only valid for cards without another type of content, so you must omit when specifying `content_id` and `content_type`.", - "enum": null, - "name": "note", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The issue or pull request id you want to associate with this card. You can use the [List issues for a repository](https://developer.github.com/v3/issues/#list-issues-for-a-repository) and [List pull requests](https://developer.github.com/v3/pulls/#list-pull-requests) endpoints to find this id. \n**Note:** Depending on whether you use the issue id or pull request id, you will need to specify `Issue` or `PullRequest` as the `content_type`.", - "enum": null, - "name": "content_id", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "**Required if you provide `content_id`**. The type of content you want to associate with this card. Use `Issue` when `content_id` is an issue id and use `PullRequest` when `content_id` is a pull request id.", - "enum": null, - "name": "content_type", - "type": "string", - "required": false - } - ] - }, - { - "name": "Move a project column", - "scope": "projects", - "id": "moveColumn", - "method": "POST", - "url": "/projects/columns/{column_id}/moves", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "column_id parameter", - "enum": null, - "name": "column_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Can be one of `first`, `last`, or `after:`, where `` is the `id` value of a column in the same project.", - "enum": null, - "name": "position", - "type": "string", - "required": true - } - ] - }, - { - "name": "Get a project", - "scope": "projects", - "id": "get", - "method": "GET", - "url": "/projects/{project_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "project_id parameter", - "enum": null, - "name": "project_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Update a project", - "scope": "projects", - "id": "update", - "method": "PATCH", - "url": "/projects/{project_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "project_id parameter", - "enum": null, - "name": "project_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The name of the project.", - "enum": null, - "name": "name", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The description of the project.", - "enum": null, - "name": "body", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "State of the project. Either `open` or `closed`.", - "enum": ["open", "closed"], - "name": "state", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The permission level that determines whether all members of the project's organization can see and/or make changes to the project. Setting `organization_permission` is only available for organization projects. If an organization member belongs to a team with a higher level of access or is a collaborator with a higher level of access, their permission level is not lowered by `organization_permission`. For information on changing access for a team or collaborator, see [Add or update team project](https://developer.github.com/v3/teams/#add-or-update-team-project) or [Add user as a collaborator](https://developer.github.com/v3/projects/collaborators/#add-user-as-a-collaborator). \n \n**Note:** Updating a project's `organization_permission` requires `admin` access to the project. \n \nCan be one of: \n\\* `read` - Organization members can read, but not write to or administer this project. \n\\* `write` - Organization members can read and write, but not administer this project. \n\\* `admin` - Organization members can read, write and administer this project. \n\\* `none` - Organization members can only see this project if it is public.", - "enum": null, - "name": "organization_permission", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Sets the visibility of a project board. Setting `private` is only available for organization and user projects. **Note:** Updating a project's visibility requires `admin` access to the project. \n \nCan be one of: \n\\* `false` - Anyone can see the project. \n\\* `true` - Only the user can view a project board created on a user account. Organization members with the appropriate `organization_permission` can see project boards in an organization account.", - "enum": null, - "name": "private", - "type": "boolean", - "required": false - } - ] - }, - { - "name": "Delete a project", - "scope": "projects", - "id": "delete", - "method": "DELETE", - "url": "/projects/{project_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "project_id parameter", - "enum": null, - "name": "project_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "List collaborators", - "scope": "projects", - "id": "listCollaborators", - "method": "GET", - "url": "/projects/{project_id}/collaborators", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "project_id parameter", - "enum": null, - "name": "project_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Filters the collaborators by their affiliation. Can be one of: \n\\* `outside`: Outside collaborators of a project that are not a member of the project's organization. \n\\* `direct`: Collaborators with permissions to a project, regardless of organization membership status. \n\\* `all`: All collaborators the authenticated user can see.", - "enum": ["outside", "direct", "all"], - "name": "affiliation", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Add user as a collaborator", - "scope": "projects", - "id": "addCollaborator", - "method": "PUT", - "url": "/projects/{project_id}/collaborators/{username}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "project_id parameter", - "enum": null, - "name": "project_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The permission to grant the collaborator. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://developer.github.com/v3/#http-verbs).\" Can be one of: \n\\* `read` - can read, but not write to or administer this project. \n\\* `write` - can read and write, but not administer this project. \n\\* `admin` - can read, write and administer this project.", - "enum": ["read", "write", "admin"], - "name": "permission", - "type": "string", - "required": false - } - ] - }, - { - "name": "Remove user as a collaborator", - "scope": "projects", - "id": "removeCollaborator", - "method": "DELETE", - "url": "/projects/{project_id}/collaborators/{username}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "project_id parameter", - "enum": null, - "name": "project_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - } - ] - }, - { - "name": "Review a user's permission level", - "scope": "projects", - "id": "reviewUserPermissionLevel", - "method": "GET", - "url": "/projects/{project_id}/collaborators/{username}/permission", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "project_id parameter", - "enum": null, - "name": "project_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - } - ] - }, - { - "name": "List project columns", - "scope": "projects", - "id": "listColumns", - "method": "GET", - "url": "/projects/{project_id}/columns", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "project_id parameter", - "enum": null, - "name": "project_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Create a project column", - "scope": "projects", - "id": "createColumn", - "method": "POST", - "url": "/projects/{project_id}/columns", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "project_id parameter", - "enum": null, - "name": "project_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The name of the column.", - "enum": null, - "name": "name", - "type": "string", - "required": true - } - ] - }, - { - "name": "Get your current rate limit status", - "scope": "rateLimit", - "id": "get", - "method": "GET", - "url": "/rate_limit", - "parameters": [] - }, - { - "name": "Delete a reaction", - "scope": "reactions", - "id": "delete", - "method": "DELETE", - "url": "/reactions/{reaction_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "reaction_id parameter", - "enum": null, - "name": "reaction_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Get", - "scope": "repos", - "id": "get", - "method": "GET", - "url": "/repos/{owner}/{repo}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - } - ] - }, - { - "name": "Edit", - "scope": "repos", - "id": "update", - "method": "PATCH", - "url": "/repos/{owner}/{repo}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The name of the repository.", - "enum": null, - "name": "name", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A short description of the repository.", - "enum": null, - "name": "description", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A URL with more information about the repository.", - "enum": null, - "name": "homepage", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Either `true` to make the repository private or `false` to make it public. Creating private repositories requires a paid GitHub account. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://help.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://help.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.", - "enum": null, - "name": "private", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Either `true` to enable issues for this repository or `false` to disable them.", - "enum": null, - "name": "has_issues", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error.", - "enum": null, - "name": "has_projects", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Either `true` to enable the wiki for this repository or `false` to disable it.", - "enum": null, - "name": "has_wiki", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Either `true` to make this repo available as a template repository or `false` to prevent it.", - "enum": null, - "name": "is_template", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Updates the default branch for this repository.", - "enum": null, - "name": "default_branch", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", - "enum": null, - "name": "allow_squash_merge", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.", - "enum": null, - "name": "allow_merge_commit", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", - "enum": null, - "name": "allow_rebase_merge", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "`true` to archive this repository. **Note**: You cannot unarchive repositories through the API.", - "enum": null, - "name": "archived", - "type": "boolean", - "required": false - } - ] - }, - { - "name": "Delete a repository", - "scope": "repos", - "id": "delete", - "method": "DELETE", - "url": "/repos/{owner}/{repo}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - } - ] - }, - { - "name": "List assignees", - "scope": "issues", - "id": "listAssignees", - "method": "GET", - "url": "/repos/{owner}/{repo}/assignees", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Check assignee", - "scope": "issues", - "id": "checkAssignee", - "method": "GET", - "url": "/repos/{owner}/{repo}/assignees/{assignee}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "assignee parameter", - "enum": null, - "name": "assignee", - "type": "string", - "required": true - } - ] - }, - { - "name": "Enable automated security fixes", - "scope": "repos", - "id": "enableAutomatedSecurityFixes", - "method": "PUT", - "url": "/repos/{owner}/{repo}/automated-security-fixes", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - } - ] - }, - { - "name": "Disable automated security fixes", - "scope": "repos", - "id": "disableAutomatedSecurityFixes", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/automated-security-fixes", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - } - ] - }, - { - "name": "List branches", - "scope": "repos", - "id": "listBranches", - "method": "GET", - "url": "/repos/{owner}/{repo}/branches", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Setting to `true` returns only protected branches. When set to `false`, only unprotected branches are returned. Omitting this parameter returns all branches.", - "enum": null, - "name": "protected", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Get branch", - "scope": "repos", - "id": "getBranch", - "method": "GET", - "url": "/repos/{owner}/{repo}/branches/{branch}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "branch parameter", - "enum": null, - "name": "branch", - "type": "string", - "required": true - } - ] - }, - { - "name": "Get branch protection", - "scope": "repos", - "id": "getBranchProtection", - "method": "GET", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "branch parameter", - "enum": null, - "name": "branch", - "type": "string", - "required": true - } - ] - }, - { - "name": "Update branch protection", - "scope": "repos", - "id": "updateBranchProtection", - "method": "PUT", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "branch parameter", - "enum": null, - "name": "branch", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": true, - "deprecated": null, - "description": "Require status checks to pass before merging. Set to `null` to disable.", - "enum": null, - "name": "required_status_checks", - "type": "object", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Require branches to be up to date before merging.", - "enum": null, - "name": "required_status_checks.strict", - "type": "boolean", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The list of status checks to require in order to merge into this branch", - "enum": null, - "name": "required_status_checks.contexts", - "type": "string[]", - "required": true - }, - { - "alias": null, - "allowNull": true, - "deprecated": null, - "description": "Enforce all configured restrictions for administrators. Set to `true` to enforce required status checks for repository administrators. Set to `null` to disable.", - "enum": null, - "name": "enforce_admins", - "type": "boolean", - "required": true - }, - { - "alias": null, - "allowNull": true, - "deprecated": null, - "description": "Require at least one approving review on a pull request, before merging. Set to `null` to disable.", - "enum": null, - "name": "required_pull_request_reviews", - "type": "object", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Specify which users and teams can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories.", - "enum": null, - "name": "required_pull_request_reviews.dismissal_restrictions", - "type": "object", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The list of user `login`s with dismissal access", - "enum": null, - "name": "required_pull_request_reviews.dismissal_restrictions.users", - "type": "string[]", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The list of team `slug`s with dismissal access", - "enum": null, - "name": "required_pull_request_reviews.dismissal_restrictions.teams", - "type": "string[]", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit.", - "enum": null, - "name": "required_pull_request_reviews.dismiss_stale_reviews", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Blocks merging pull requests until [code owners](https://help.github.com/articles/about-code-owners/) review them.", - "enum": null, - "name": "required_pull_request_reviews.require_code_owner_reviews", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6.", - "enum": null, - "name": "required_pull_request_reviews.required_approving_review_count", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": true, - "deprecated": null, - "description": "Restrict who can push to this branch. User, app, and team `restrictions` are only available for organization-owned repositories. Set to `null` to disable.", - "enum": null, - "name": "restrictions", - "type": "object", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The list of user `login`s with push access", - "enum": null, - "name": "restrictions.users", - "type": "string[]", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The list of team `slug`s with push access", - "enum": null, - "name": "restrictions.teams", - "type": "string[]", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The list of app `slug`s with push access", - "enum": null, - "name": "restrictions.apps", - "type": "string[]", - "required": false - } - ] - }, - { - "name": "Remove branch protection", - "scope": "repos", - "id": "removeBranchProtection", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "branch parameter", - "enum": null, - "name": "branch", - "type": "string", - "required": true - } - ] - }, - { - "name": "Get admin enforcement of protected branch", - "scope": "repos", - "id": "getProtectedBranchAdminEnforcement", - "method": "GET", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "branch parameter", - "enum": null, - "name": "branch", - "type": "string", - "required": true - } - ] - }, - { - "name": "Add admin enforcement of protected branch", - "scope": "repos", - "id": "addProtectedBranchAdminEnforcement", - "method": "POST", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "branch parameter", - "enum": null, - "name": "branch", - "type": "string", - "required": true - } - ] - }, - { - "name": "Remove admin enforcement of protected branch", - "scope": "repos", - "id": "removeProtectedBranchAdminEnforcement", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "branch parameter", - "enum": null, - "name": "branch", - "type": "string", - "required": true - } - ] - }, - { - "name": "Get pull request review enforcement of protected branch", - "scope": "repos", - "id": "getProtectedBranchPullRequestReviewEnforcement", - "method": "GET", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "branch parameter", - "enum": null, - "name": "branch", - "type": "string", - "required": true - } - ] - }, - { - "name": "Update pull request review enforcement of protected branch", - "scope": "repos", - "id": "updateProtectedBranchPullRequestReviewEnforcement", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "branch parameter", - "enum": null, - "name": "branch", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Specify which users and teams can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories.", - "enum": null, - "name": "dismissal_restrictions", - "type": "object", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The list of user `login`s with dismissal access", - "enum": null, - "name": "dismissal_restrictions.users", - "type": "string[]", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The list of team `slug`s with dismissal access", - "enum": null, - "name": "dismissal_restrictions.teams", - "type": "string[]", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit.", - "enum": null, - "name": "dismiss_stale_reviews", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Blocks merging pull requests until [code owners](https://help.github.com/articles/about-code-owners/) have reviewed.", - "enum": null, - "name": "require_code_owner_reviews", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6.", - "enum": null, - "name": "required_approving_review_count", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Remove pull request review enforcement of protected branch", - "scope": "repos", - "id": "removeProtectedBranchPullRequestReviewEnforcement", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "branch parameter", - "enum": null, - "name": "branch", - "type": "string", - "required": true - } - ] - }, - { - "name": "Get required signatures of protected branch", - "scope": "repos", - "id": "getProtectedBranchRequiredSignatures", - "method": "GET", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "branch parameter", - "enum": null, - "name": "branch", - "type": "string", - "required": true - } - ] - }, - { - "name": "Add required signatures of protected branch", - "scope": "repos", - "id": "addProtectedBranchRequiredSignatures", - "method": "POST", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "branch parameter", - "enum": null, - "name": "branch", - "type": "string", - "required": true - } - ] - }, - { - "name": "Remove required signatures of protected branch", - "scope": "repos", - "id": "removeProtectedBranchRequiredSignatures", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "branch parameter", - "enum": null, - "name": "branch", - "type": "string", - "required": true - } - ] - }, - { - "name": "Get required status checks of protected branch", - "scope": "repos", - "id": "getProtectedBranchRequiredStatusChecks", - "method": "GET", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "branch parameter", - "enum": null, - "name": "branch", - "type": "string", - "required": true - } - ] - }, - { - "name": "Update required status checks of protected branch", - "scope": "repos", - "id": "updateProtectedBranchRequiredStatusChecks", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "branch parameter", - "enum": null, - "name": "branch", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Require branches to be up to date before merging.", - "enum": null, - "name": "strict", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The list of status checks to require in order to merge into this branch", - "enum": null, - "name": "contexts", - "type": "string[]", - "required": false - } - ] - }, - { - "name": "Remove required status checks of protected branch", - "scope": "repos", - "id": "removeProtectedBranchRequiredStatusChecks", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "branch parameter", - "enum": null, - "name": "branch", - "type": "string", - "required": true - } - ] - }, - { - "name": "List required status checks contexts of protected branch", - "scope": "repos", - "id": "listProtectedBranchRequiredStatusChecksContexts", - "method": "GET", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "branch parameter", - "enum": null, - "name": "branch", - "type": "string", - "required": true - } - ] - }, - { - "name": "Replace required status checks contexts of protected branch", - "scope": "repos", - "id": "replaceProtectedBranchRequiredStatusChecksContexts", - "method": "PUT", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "branch parameter", - "enum": null, - "name": "branch", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "contexts parameter", - "enum": null, - "name": "contexts", - "type": "string[]", - "required": true - } - ] - }, - { - "name": "Add required status checks contexts of protected branch", - "scope": "repos", - "id": "addProtectedBranchRequiredStatusChecksContexts", - "method": "POST", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "branch parameter", - "enum": null, - "name": "branch", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "contexts parameter", - "enum": null, - "name": "contexts", - "type": "string[]", - "required": true - } - ] - }, - { - "name": "Remove required status checks contexts of protected branch", - "scope": "repos", - "id": "removeProtectedBranchRequiredStatusChecksContexts", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "branch parameter", - "enum": null, - "name": "branch", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "contexts parameter", - "enum": null, - "name": "contexts", - "type": "string[]", - "required": true - } - ] - }, - { - "name": "Get restrictions of protected branch", - "scope": "repos", - "id": "getProtectedBranchRestrictions", - "method": "GET", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "branch parameter", - "enum": null, - "name": "branch", - "type": "string", - "required": true - } - ] - }, - { - "name": "Remove restrictions of protected branch", - "scope": "repos", - "id": "removeProtectedBranchRestrictions", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "branch parameter", - "enum": null, - "name": "branch", - "type": "string", - "required": true - } - ] - }, - { - "name": "Get apps with access to protected branch", - "scope": "repos", - "id": "getAppsWithAccessToProtectedBranch", - "method": "GET", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "branch parameter", - "enum": null, - "name": "branch", - "type": "string", - "required": true - } - ] - }, - { - "name": "Get apps with access to protected branch", - "scope": "repos", - "id": "listAppsWithAccessToProtectedBranch", - "method": "GET", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "branch parameter", - "enum": null, - "name": "branch", - "type": "string", - "required": true - } - ] - }, - { - "name": "Replace app restrictions of protected branch", - "scope": "repos", - "id": "replaceProtectedBranchAppRestrictions", - "method": "PUT", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "branch parameter", - "enum": null, - "name": "branch", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "apps parameter", - "enum": null, - "name": "apps", - "type": "string[]", - "required": true - } - ] - }, - { - "name": "Add app restrictions of protected branch", - "scope": "repos", - "id": "addProtectedBranchAppRestrictions", - "method": "POST", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "branch parameter", - "enum": null, - "name": "branch", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "apps parameter", - "enum": null, - "name": "apps", - "type": "string[]", - "required": true - } - ] - }, - { - "name": "Remove app restrictions of protected branch", - "scope": "repos", - "id": "removeProtectedBranchAppRestrictions", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "branch parameter", - "enum": null, - "name": "branch", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "apps parameter", - "enum": null, - "name": "apps", - "type": "string[]", - "required": true - } - ] - }, - { - "name": "Get teams with access to protected branch", - "scope": "repos", - "id": "getTeamsWithAccessToProtectedBranch", - "method": "GET", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "branch parameter", - "enum": null, - "name": "branch", - "type": "string", - "required": true - } - ] - }, - { - "name": "Get teams with access to protected branch", - "scope": "repos", - "id": "listProtectedBranchTeamRestrictions", - "method": "GET", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "branch parameter", - "enum": null, - "name": "branch", - "type": "string", - "required": true - } - ] - }, - { - "name": "Get teams with access to protected branch", - "scope": "repos", - "id": "listTeamsWithAccessToProtectedBranch", - "method": "GET", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "branch parameter", - "enum": null, - "name": "branch", - "type": "string", - "required": true - } - ] - }, - { - "name": "Replace team restrictions of protected branch", - "scope": "repos", - "id": "replaceProtectedBranchTeamRestrictions", - "method": "PUT", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "branch parameter", - "enum": null, - "name": "branch", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "teams parameter", - "enum": null, - "name": "teams", - "type": "string[]", - "required": true - } - ] - }, - { - "name": "Add team restrictions of protected branch", - "scope": "repos", - "id": "addProtectedBranchTeamRestrictions", - "method": "POST", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "branch parameter", - "enum": null, - "name": "branch", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "teams parameter", - "enum": null, - "name": "teams", - "type": "string[]", - "required": true - } - ] - }, - { - "name": "Remove team restrictions of protected branch", - "scope": "repos", - "id": "removeProtectedBranchTeamRestrictions", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "branch parameter", - "enum": null, - "name": "branch", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "teams parameter", - "enum": null, - "name": "teams", - "type": "string[]", - "required": true - } - ] - }, - { - "name": "Get users with access to protected branch", - "scope": "repos", - "id": "getUsersWithAccessToProtectedBranch", - "method": "GET", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "branch parameter", - "enum": null, - "name": "branch", - "type": "string", - "required": true - } - ] - }, - { - "name": "Get users with access to protected branch", - "scope": "repos", - "id": "listProtectedBranchUserRestrictions", - "method": "GET", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "branch parameter", - "enum": null, - "name": "branch", - "type": "string", - "required": true - } - ] - }, - { - "name": "Get users with access to protected branch", - "scope": "repos", - "id": "listUsersWithAccessToProtectedBranch", - "method": "GET", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "branch parameter", - "enum": null, - "name": "branch", - "type": "string", - "required": true - } - ] - }, - { - "name": "Replace user restrictions of protected branch", - "scope": "repos", - "id": "replaceProtectedBranchUserRestrictions", - "method": "PUT", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "branch parameter", - "enum": null, - "name": "branch", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "users parameter", - "enum": null, - "name": "users", - "type": "string[]", - "required": true - } - ] - }, - { - "name": "Add user restrictions of protected branch", - "scope": "repos", - "id": "addProtectedBranchUserRestrictions", - "method": "POST", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "branch parameter", - "enum": null, - "name": "branch", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "users parameter", - "enum": null, - "name": "users", - "type": "string[]", - "required": true - } - ] - }, - { - "name": "Remove user restrictions of protected branch", - "scope": "repos", - "id": "removeProtectedBranchUserRestrictions", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "branch parameter", - "enum": null, - "name": "branch", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "users parameter", - "enum": null, - "name": "users", - "type": "string[]", - "required": true - } - ] - }, - { - "name": "Create a check run", - "scope": "checks", - "id": "create", - "method": "POST", - "url": "/repos/{owner}/{repo}/check-runs", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The name of the check. For example, \"code-coverage\".", - "enum": null, - "name": "name", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The SHA of the commit.", - "enum": null, - "name": "head_sha", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The URL of the integrator's site that has the full details of the check.", - "enum": null, - "name": "details_url", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A reference for the run on the integrator's system.", - "enum": null, - "name": "external_id", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The current status. Can be one of `queued`, `in_progress`, or `completed`.", - "enum": ["queued", "in_progress", "completed"], - "name": "status", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The time that the check run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "enum": null, - "name": "started_at", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, or `action_required`. When the conclusion is `action_required`, additional details should be provided on the site specified by `details_url`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`.", - "enum": [ - "success", - "failure", - "neutral", - "cancelled", - "timed_out", - "action_required" - ], - "name": "conclusion", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "enum": null, - "name": "completed_at", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://developer.github.com/v3/checks/runs/#output-object) description.", - "enum": null, - "name": "output", - "type": "object", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The title of the check run.", - "enum": null, - "name": "output.title", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The summary of the check run. This parameter supports Markdown.", - "enum": null, - "name": "output.summary", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The details of the check run. This parameter supports Markdown.", - "enum": null, - "name": "output.text", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://developer.github.com/v3/checks/runs/#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"[About status checks](https://help.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://developer.github.com/v3/checks/runs/#annotations-object) description for details about how to use this parameter.", - "enum": null, - "name": "output.annotations", - "type": "object[]", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "enum": null, - "name": "output.annotations[].path", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The start line of the annotation.", - "enum": null, - "name": "output.annotations[].start_line", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The end line of the annotation.", - "enum": null, - "name": "output.annotations[].end_line", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "enum": null, - "name": "output.annotations[].start_column", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "enum": null, - "name": "output.annotations[].end_column", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The level of the annotation. Can be one of `notice`, `warning`, or `failure`.", - "enum": ["notice", "warning", "failure"], - "name": "output.annotations[].annotation_level", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "enum": null, - "name": "output.annotations[].message", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The title that represents the annotation. The maximum size is 255 characters.", - "enum": null, - "name": "output.annotations[].title", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Details about this annotation. The maximum size is 64 KB.", - "enum": null, - "name": "output.annotations[].raw_details", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://developer.github.com/v3/checks/runs/#images-object) description for details.", - "enum": null, - "name": "output.images", - "type": "object[]", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The alternative text for the image.", - "enum": null, - "name": "output.images[].alt", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The full URL of the image.", - "enum": null, - "name": "output.images[].image_url", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A short image description.", - "enum": null, - "name": "output.images[].caption", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://developer.github.com/v3/activity/events/types/#checkrunevent) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://developer.github.com/v3/checks/runs/#actions-object) description. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://developer.github.com/v3/checks/runs/#check-runs-and-requested-actions).\" To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://developer.github.com/v3/checks/runs/#check-runs-and-requested-actions).\"", - "enum": null, - "name": "actions", - "type": "object[]", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The text to be displayed on a button in the web UI. The maximum size is 20 characters.", - "enum": null, - "name": "actions[].label", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A short explanation of what this action would do. The maximum size is 40 characters.", - "enum": null, - "name": "actions[].description", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A reference for the action on the integrator's system. The maximum size is 20 characters.", - "enum": null, - "name": "actions[].identifier", - "type": "string", - "required": true - } - ] - }, - { - "name": "Update a check run", - "scope": "checks", - "id": "update", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/check-runs/{check_run_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "check_run_id parameter", - "enum": null, - "name": "check_run_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The name of the check. For example, \"code-coverage\".", - "enum": null, - "name": "name", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The URL of the integrator's site that has the full details of the check.", - "enum": null, - "name": "details_url", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A reference for the run on the integrator's system.", - "enum": null, - "name": "external_id", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "enum": null, - "name": "started_at", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The current status. Can be one of `queued`, `in_progress`, or `completed`.", - "enum": ["queued", "in_progress", "completed"], - "name": "status", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, or `action_required`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`.", - "enum": [ - "success", - "failure", - "neutral", - "cancelled", - "timed_out", - "action_required" - ], - "name": "conclusion", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "enum": null, - "name": "completed_at", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://developer.github.com/v3/checks/runs/#output-object-1) description.", - "enum": null, - "name": "output", - "type": "object", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "**Required**.", - "enum": null, - "name": "output.title", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Can contain Markdown.", - "enum": null, - "name": "output.summary", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Can contain Markdown.", - "enum": null, - "name": "output.text", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://developer.github.com/v3/checks/runs/#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"[About status checks](https://help.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://developer.github.com/v3/checks/runs/#annotations-object-1) description for details.", - "enum": null, - "name": "output.annotations", - "type": "object[]", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "enum": null, - "name": "output.annotations[].path", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The start line of the annotation.", - "enum": null, - "name": "output.annotations[].start_line", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The end line of the annotation.", - "enum": null, - "name": "output.annotations[].end_line", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "enum": null, - "name": "output.annotations[].start_column", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "enum": null, - "name": "output.annotations[].end_column", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The level of the annotation. Can be one of `notice`, `warning`, or `failure`.", - "enum": ["notice", "warning", "failure"], - "name": "output.annotations[].annotation_level", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "enum": null, - "name": "output.annotations[].message", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The title that represents the annotation. The maximum size is 255 characters.", - "enum": null, - "name": "output.annotations[].title", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Details about this annotation. The maximum size is 64 KB.", - "enum": null, - "name": "output.annotations[].raw_details", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://developer.github.com/v3/checks/runs/#annotations-object-1) description for details.", - "enum": null, - "name": "output.images", - "type": "object[]", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The alternative text for the image.", - "enum": null, - "name": "output.images[].alt", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The full URL of the image.", - "enum": null, - "name": "output.images[].image_url", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A short image description.", - "enum": null, - "name": "output.images[].caption", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://developer.github.com/v3/checks/runs/#actions-object) description. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://developer.github.com/v3/checks/runs/#check-runs-and-requested-actions).\"", - "enum": null, - "name": "actions", - "type": "object[]", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The text to be displayed on a button in the web UI. The maximum size is 20 characters.", - "enum": null, - "name": "actions[].label", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A short explanation of what this action would do. The maximum size is 40 characters.", - "enum": null, - "name": "actions[].description", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A reference for the action on the integrator's system. The maximum size is 20 characters.", - "enum": null, - "name": "actions[].identifier", - "type": "string", - "required": true - } - ] - }, - { - "name": "Get a single check run", - "scope": "checks", - "id": "get", - "method": "GET", - "url": "/repos/{owner}/{repo}/check-runs/{check_run_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "check_run_id parameter", - "enum": null, - "name": "check_run_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "List annotations for a check run", - "scope": "checks", - "id": "listAnnotations", - "method": "GET", - "url": "/repos/{owner}/{repo}/check-runs/{check_run_id}/annotations", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "check_run_id parameter", - "enum": null, - "name": "check_run_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Create a check suite", - "scope": "checks", - "id": "createSuite", - "method": "POST", - "url": "/repos/{owner}/{repo}/check-suites", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The sha of the head commit.", - "enum": null, - "name": "head_sha", - "type": "string", - "required": true - } - ] - }, - { - "name": "Set preferences for check suites on a repository", - "scope": "checks", - "id": "setSuitesPreferences", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/check-suites/preferences", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the [`auto_trigger_checks` object](https://developer.github.com/v3/checks/suites/#auto_trigger_checks-object) description for details.", - "enum": null, - "name": "auto_trigger_checks", - "type": "object[]", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The `id` of the GitHub App.", - "enum": null, - "name": "auto_trigger_checks[].app_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Set to `true` to enable automatic creation of CheckSuite events upon pushes to the repository, or `false` to disable them.", - "enum": null, - "name": "auto_trigger_checks[].setting", - "type": "boolean", - "required": true - } - ] - }, - { - "name": "Get a single check suite", - "scope": "checks", - "id": "getSuite", - "method": "GET", - "url": "/repos/{owner}/{repo}/check-suites/{check_suite_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "check_suite_id parameter", - "enum": null, - "name": "check_suite_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "List check runs in a check suite", - "scope": "checks", - "id": "listForSuite", - "method": "GET", - "url": "/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "check_suite_id parameter", - "enum": null, - "name": "check_suite_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Returns check runs with the specified `name`.", - "enum": null, - "name": "check_name", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Returns check runs with the specified `status`. Can be one of `queued`, `in_progress`, or `completed`.", - "enum": ["queued", "in_progress", "completed"], - "name": "status", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Filters check runs by their `completed_at` timestamp. Can be one of `latest` (returning the most recent check runs) or `all`.", - "enum": ["latest", "all"], - "name": "filter", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Rerequest check suite", - "scope": "checks", - "id": "rerequestSuite", - "method": "POST", - "url": "/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "check_suite_id parameter", - "enum": null, - "name": "check_suite_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "List collaborators", - "scope": "repos", - "id": "listCollaborators", - "method": "GET", - "url": "/repos/{owner}/{repo}/collaborators", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Filter collaborators returned by their affiliation. Can be one of: \n\\* `outside`: All outside collaborators of an organization-owned repository. \n\\* `direct`: All collaborators with permissions to an organization-owned repository, regardless of organization membership status. \n\\* `all`: All collaborators the authenticated user can see.", - "enum": ["outside", "direct", "all"], - "name": "affiliation", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Check if a user is a collaborator", - "scope": "repos", - "id": "checkCollaborator", - "method": "GET", - "url": "/repos/{owner}/{repo}/collaborators/{username}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - } - ] - }, - { - "name": "Add user as a collaborator", - "scope": "repos", - "id": "addCollaborator", - "method": "PUT", - "url": "/repos/{owner}/{repo}/collaborators/{username}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The permission to grant the collaborator. **Only valid on organization-owned repositories.** Can be one of: \n\\* `pull` - can pull, but not push to or administer this repository. \n\\* `push` - can pull and push, but not administer this repository. \n\\* `admin` - can pull, push and administer this repository.", - "enum": ["pull", "push", "admin"], - "name": "permission", - "type": "string", - "required": false - } - ] - }, - { - "name": "Remove user as a collaborator", - "scope": "repos", - "id": "removeCollaborator", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/collaborators/{username}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - } - ] - }, - { - "name": "Review a user's permission level", - "scope": "repos", - "id": "getCollaboratorPermissionLevel", - "method": "GET", - "url": "/repos/{owner}/{repo}/collaborators/{username}/permission", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - } - ] - }, - { - "name": "List commit comments for a repository", - "scope": "repos", - "id": "listCommitComments", - "method": "GET", - "url": "/repos/{owner}/{repo}/comments", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Get a single commit comment", - "scope": "repos", - "id": "getCommitComment", - "method": "GET", - "url": "/repos/{owner}/{repo}/comments/{comment_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "comment_id parameter", - "enum": null, - "name": "comment_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Update a commit comment", - "scope": "repos", - "id": "updateCommitComment", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/comments/{comment_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "comment_id parameter", - "enum": null, - "name": "comment_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The contents of the comment", - "enum": null, - "name": "body", - "type": "string", - "required": true - } - ] - }, - { - "name": "Delete a commit comment", - "scope": "repos", - "id": "deleteCommitComment", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/comments/{comment_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "comment_id parameter", - "enum": null, - "name": "comment_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "List reactions for a commit comment", - "scope": "reactions", - "id": "listForCommitComment", - "method": "GET", - "url": "/repos/{owner}/{repo}/comments/{comment_id}/reactions", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "comment_id parameter", - "enum": null, - "name": "comment_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a commit comment.", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "name": "content", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Create reaction for a commit comment", - "scope": "reactions", - "id": "createForCommitComment", - "method": "POST", - "url": "/repos/{owner}/{repo}/comments/{comment_id}/reactions", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "comment_id parameter", - "enum": null, - "name": "comment_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the commit comment.", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "name": "content", - "type": "string", - "required": true - } - ] - }, - { - "name": "List commits on a repository", - "scope": "repos", - "id": "listCommits", - "method": "GET", - "url": "/repos/{owner}/{repo}/commits", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "SHA or branch to start listing commits from. Default: the repository’s default branch (usually `master`).", - "enum": null, - "name": "sha", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Only commits containing this file path will be returned.", - "enum": null, - "name": "path", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "GitHub login or email address by which to filter by commit author.", - "enum": null, - "name": "author", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Only commits after this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "enum": null, - "name": "since", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "enum": null, - "name": "until", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "List branches for HEAD commit", - "scope": "repos", - "id": "listBranchesForHeadCommit", - "method": "GET", - "url": "/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "commit_sha parameter", - "enum": null, - "name": "commit_sha", - "type": "string", - "required": true - } - ] - }, - { - "name": "List comments for a single commit", - "scope": "repos", - "id": "listCommentsForCommit", - "method": "GET", - "url": "/repos/{owner}/{repo}/commits/{commit_sha}/comments", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "commit_sha parameter", - "enum": null, - "name": "commit_sha", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - }, - { - "alias": "commit_sha", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "ref", - "type": null, - "required": null - } - ] - }, - { - "name": "Create a commit comment", - "scope": "repos", - "id": "createCommitComment", - "method": "POST", - "url": "/repos/{owner}/{repo}/commits/{commit_sha}/comments", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "commit_sha parameter", - "enum": null, - "name": "commit_sha", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The contents of the comment.", - "enum": null, - "name": "body", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Relative path of the file to comment on.", - "enum": null, - "name": "path", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Line index in the diff to comment on.", - "enum": null, - "name": "position", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "**Deprecated**. Use **position** parameter instead. Line number in the file to comment on.", - "enum": null, - "name": "line", - "type": "integer", - "required": false - }, - { - "alias": "commit_sha", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "sha", - "type": null, - "required": null - } - ] - }, - { - "name": "List pull requests associated with commit", - "scope": "repos", - "id": "listPullRequestsAssociatedWithCommit", - "method": "GET", - "url": "/repos/{owner}/{repo}/commits/{commit_sha}/pulls", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "commit_sha parameter", - "enum": null, - "name": "commit_sha", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Get a single commit", - "scope": "repos", - "id": "getCommit", - "method": "GET", - "url": "/repos/{owner}/{repo}/commits/{ref}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "ref parameter", - "enum": null, - "name": "ref", - "type": "string", - "required": true - }, - { - "alias": "ref", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "sha", - "type": null, - "required": null - }, - { - "alias": "ref", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "commit_sha", - "type": null, - "required": null - } - ] - }, - { - "name": "List check runs for a specific ref", - "scope": "checks", - "id": "listForRef", - "method": "GET", - "url": "/repos/{owner}/{repo}/commits/{ref}/check-runs", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "ref parameter", - "enum": null, - "name": "ref", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Returns check runs with the specified `name`.", - "enum": null, - "name": "check_name", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Returns check runs with the specified `status`. Can be one of `queued`, `in_progress`, or `completed`.", - "enum": ["queued", "in_progress", "completed"], - "name": "status", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Filters check runs by their `completed_at` timestamp. Can be one of `latest` (returning the most recent check runs) or `all`.", - "enum": ["latest", "all"], - "name": "filter", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "List check suites for a specific ref", - "scope": "checks", - "id": "listSuitesForRef", - "method": "GET", - "url": "/repos/{owner}/{repo}/commits/{ref}/check-suites", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "ref parameter", - "enum": null, - "name": "ref", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Filters check suites by GitHub App `id`.", - "enum": null, - "name": "app_id", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Filters checks suites by the name of the [check run](https://developer.github.com/v3/checks/runs/).", - "enum": null, - "name": "check_name", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Get the combined status for a specific ref", - "scope": "repos", - "id": "getCombinedStatusForRef", - "method": "GET", - "url": "/repos/{owner}/{repo}/commits/{ref}/status", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "ref parameter", - "enum": null, - "name": "ref", - "type": "string", - "required": true - } - ] - }, - { - "name": "List statuses for a specific ref", - "scope": "repos", - "id": "listStatusesForRef", - "method": "GET", - "url": "/repos/{owner}/{repo}/commits/{ref}/statuses", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "ref parameter", - "enum": null, - "name": "ref", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Get the contents of a repository's code of conduct", - "scope": "codesOfConduct", - "id": "getForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/community/code_of_conduct", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - } - ] - }, - { - "name": "Retrieve community profile metrics", - "scope": "repos", - "id": "retrieveCommunityProfileMetrics", - "method": "GET", - "url": "/repos/{owner}/{repo}/community/profile", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - } - ] - }, - { - "name": "Compare two commits", - "scope": "repos", - "id": "compareCommits", - "method": "GET", - "url": "/repos/{owner}/{repo}/compare/{base}...{head}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "base parameter", - "enum": null, - "name": "base", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "head parameter", - "enum": null, - "name": "head", - "type": "string", - "required": true - } - ] - }, - { - "name": "Get contents", - "scope": "repos", - "id": "getContents", - "method": "GET", - "url": "/repos/{owner}/{repo}/contents/{path}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "path parameter", - "enum": null, - "name": "path", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)", - "enum": null, - "name": "ref", - "type": "string", - "required": false - } - ] - }, - { - "name": "Create or update a file", - "scope": "repos", - "id": "createOrUpdateFile", - "method": "PUT", - "url": "/repos/{owner}/{repo}/contents/{path}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "path parameter", - "enum": null, - "name": "path", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The commit message.", - "enum": null, - "name": "message", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The new file content, using Base64 encoding.", - "enum": null, - "name": "content", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "**Required if you are updating a file**. The blob SHA of the file being replaced.", - "enum": null, - "name": "sha", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The branch name. Default: the repository’s default branch (usually `master`)", - "enum": null, - "name": "branch", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The person that committed the file. Default: the authenticated user.", - "enum": null, - "name": "committer", - "type": "object", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", - "enum": null, - "name": "committer.name", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The email of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", - "enum": null, - "name": "committer.email", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The author of the file. Default: The `committer` or the authenticated user if you omit `committer`.", - "enum": null, - "name": "author", - "type": "object", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", - "enum": null, - "name": "author.name", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The email of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", - "enum": null, - "name": "author.email", - "type": "string", - "required": true - } - ] - }, - { - "name": "Create or update a file", - "scope": "repos", - "id": "createFile", - "method": "PUT", - "url": "/repos/{owner}/{repo}/contents/{path}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "path parameter", - "enum": null, - "name": "path", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The commit message.", - "enum": null, - "name": "message", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The new file content, using Base64 encoding.", - "enum": null, - "name": "content", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "**Required if you are updating a file**. The blob SHA of the file being replaced.", - "enum": null, - "name": "sha", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The branch name. Default: the repository’s default branch (usually `master`)", - "enum": null, - "name": "branch", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The person that committed the file. Default: the authenticated user.", - "enum": null, - "name": "committer", - "type": "object", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", - "enum": null, - "name": "committer.name", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The email of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", - "enum": null, - "name": "committer.email", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The author of the file. Default: The `committer` or the authenticated user if you omit `committer`.", - "enum": null, - "name": "author", - "type": "object", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", - "enum": null, - "name": "author.name", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The email of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", - "enum": null, - "name": "author.email", - "type": "string", - "required": true - } - ] - }, - { - "name": "Create or update a file", - "scope": "repos", - "id": "updateFile", - "method": "PUT", - "url": "/repos/{owner}/{repo}/contents/{path}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "path parameter", - "enum": null, - "name": "path", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The commit message.", - "enum": null, - "name": "message", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The new file content, using Base64 encoding.", - "enum": null, - "name": "content", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "**Required if you are updating a file**. The blob SHA of the file being replaced.", - "enum": null, - "name": "sha", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The branch name. Default: the repository’s default branch (usually `master`)", - "enum": null, - "name": "branch", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The person that committed the file. Default: the authenticated user.", - "enum": null, - "name": "committer", - "type": "object", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", - "enum": null, - "name": "committer.name", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The email of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", - "enum": null, - "name": "committer.email", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The author of the file. Default: The `committer` or the authenticated user if you omit `committer`.", - "enum": null, - "name": "author", - "type": "object", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", - "enum": null, - "name": "author.name", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The email of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", - "enum": null, - "name": "author.email", - "type": "string", - "required": true - } - ] - }, - { - "name": "Delete a file", - "scope": "repos", - "id": "deleteFile", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/contents/{path}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "path parameter", - "enum": null, - "name": "path", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The commit message.", - "enum": null, - "name": "message", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The blob SHA of the file being replaced.", - "enum": null, - "name": "sha", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The branch name. Default: the repository’s default branch (usually `master`)", - "enum": null, - "name": "branch", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "object containing information about the committer.", - "enum": null, - "name": "committer", - "type": "object", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The name of the author (or committer) of the commit", - "enum": null, - "name": "committer.name", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The email of the author (or committer) of the commit", - "enum": null, - "name": "committer.email", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "object containing information about the author.", - "enum": null, - "name": "author", - "type": "object", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The name of the author (or committer) of the commit", - "enum": null, - "name": "author.name", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The email of the author (or committer) of the commit", - "enum": null, - "name": "author.email", - "type": "string", - "required": false - } - ] - }, - { - "name": "List contributors", - "scope": "repos", - "id": "listContributors", - "method": "GET", - "url": "/repos/{owner}/{repo}/contributors", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Set to `1` or `true` to include anonymous contributors in results.", - "enum": null, - "name": "anon", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "List deployments", - "scope": "repos", - "id": "listDeployments", - "method": "GET", - "url": "/repos/{owner}/{repo}/deployments", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The SHA recorded at creation time.", - "enum": null, - "name": "sha", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The name of the ref. This can be a branch, tag, or SHA.", - "enum": null, - "name": "ref", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The name of the task for the deployment (e.g., `deploy` or `deploy:migrations`).", - "enum": null, - "name": "task", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The name of the environment that was deployed to (e.g., `staging` or `production`).", - "enum": null, - "name": "environment", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Create a deployment", - "scope": "repos", - "id": "createDeployment", - "method": "POST", - "url": "/repos/{owner}/{repo}/deployments", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The ref to deploy. This can be a branch, tag, or SHA.", - "enum": null, - "name": "ref", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Specifies a task to execute (e.g., `deploy` or `deploy:migrations`).", - "enum": null, - "name": "task", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch.", - "enum": null, - "name": "auto_merge", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The [status](https://developer.github.com/v3/repos/statuses/) contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.", - "enum": null, - "name": "required_contexts", - "type": "string[]", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "JSON payload with extra information about the deployment.", - "enum": null, - "name": "payload", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Name for the target deployment environment (e.g., `production`, `staging`, `qa`).", - "enum": null, - "name": "environment", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Short description of the deployment.", - "enum": null, - "name": "description", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: `false` \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type. **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type.", - "enum": null, - "name": "transient_environment", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Specifies if the given environment is one that end-users directly interact with. Default: `true` when `environment` is `production` and `false` otherwise. \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type.", - "enum": null, - "name": "production_environment", - "type": "boolean", - "required": false - } - ] - }, - { - "name": "Get a single deployment", - "scope": "repos", - "id": "getDeployment", - "method": "GET", - "url": "/repos/{owner}/{repo}/deployments/{deployment_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "deployment_id parameter", - "enum": null, - "name": "deployment_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "List deployment statuses", - "scope": "repos", - "id": "listDeploymentStatuses", - "method": "GET", - "url": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "deployment_id parameter", - "enum": null, - "name": "deployment_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Create a deployment status", - "scope": "repos", - "id": "createDeploymentStatus", - "method": "POST", - "url": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "deployment_id parameter", - "enum": null, - "name": "deployment_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The state of the status. Can be one of `error`, `failure`, `inactive`, `in_progress`, `queued` `pending`, or `success`. **Note:** To use the `inactive` state, you must provide the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type. To use the `in_progress` and `queued` states, you must provide the [`application/vnd.github.flash-preview+json`](https://developer.github.com/v3/previews/#deployment-statuses) custom media type.", - "enum": [ - "error", - "failure", - "inactive", - "in_progress", - "queued", - "pending", - "success" - ], - "name": "state", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. **Note:** It's recommended to use the `log_url` parameter, which replaces `target_url`.", - "enum": null, - "name": "target_url", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The full URL of the deployment's output. This parameter replaces `target_url`. We will continue to accept `target_url` to support legacy uses, but we recommend replacing `target_url` with `log_url`. Setting `log_url` will automatically set `target_url` to the same value. Default: `\"\"` \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type. **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type.", - "enum": null, - "name": "log_url", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A short description of the status. The maximum description length is 140 characters.", - "enum": null, - "name": "description", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Name for the target deployment environment, which can be changed when setting a deploy status. For example, `production`, `staging`, or `qa`. **Note:** This parameter requires you to use the [`application/vnd.github.flash-preview+json`](https://developer.github.com/v3/previews/#deployment-statuses) custom media type.", - "enum": ["production", "staging", "qa"], - "name": "environment", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Sets the URL for accessing your environment. Default: `\"\"` \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type. **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type.", - "enum": null, - "name": "environment_url", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Adds a new `inactive` status to all prior non-transient, non-production environment deployments with the same repository and `environment` name as the created status's deployment. An `inactive` status is only added to deployments that had a `success` state. Default: `true` \n**Note:** To add an `inactive` status to `production` environments, you must use the [`application/vnd.github.flash-preview+json`](https://developer.github.com/v3/previews/#deployment-statuses) custom media type. \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type.", - "enum": null, - "name": "auto_inactive", - "type": "boolean", - "required": false - } - ] - }, - { - "name": "Get a single deployment status", - "scope": "repos", - "id": "getDeploymentStatus", - "method": "GET", - "url": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "deployment_id parameter", - "enum": null, - "name": "deployment_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "status_id parameter", - "enum": null, - "name": "status_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Create a repository dispatch event", - "scope": "repos", - "id": "createDispatchEvent", - "method": "POST", - "url": "/repos/{owner}/{repo}/dispatches", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "**Required:** A custom webhook event name.", - "enum": null, - "name": "event_type", - "type": "string", - "required": false - } - ] - }, - { - "name": "List downloads for a repository", - "scope": "repos", - "id": "listDownloads", - "method": "GET", - "url": "/repos/{owner}/{repo}/downloads", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Get a single download", - "scope": "repos", - "id": "getDownload", - "method": "GET", - "url": "/repos/{owner}/{repo}/downloads/{download_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "download_id parameter", - "enum": null, - "name": "download_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Delete a download", - "scope": "repos", - "id": "deleteDownload", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/downloads/{download_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "download_id parameter", - "enum": null, - "name": "download_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "List repository events", - "scope": "activity", - "id": "listRepoEvents", - "method": "GET", - "url": "/repos/{owner}/{repo}/events", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "List forks", - "scope": "repos", - "id": "listForks", - "method": "GET", - "url": "/repos/{owner}/{repo}/forks", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The sort order. Can be either `newest`, `oldest`, or `stargazers`.", - "enum": ["newest", "oldest", "stargazers"], - "name": "sort", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Create a fork", - "scope": "repos", - "id": "createFork", - "method": "POST", - "url": "/repos/{owner}/{repo}/forks", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Optional parameter to specify the organization name if forking into an organization.", - "enum": null, - "name": "organization", - "type": "string", - "required": false - } - ] - }, - { - "name": "Create a blob", - "scope": "git", - "id": "createBlob", - "method": "POST", - "url": "/repos/{owner}/{repo}/git/blobs", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The new blob's content.", - "enum": null, - "name": "content", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", - "enum": null, - "name": "encoding", - "type": "string", - "required": false - } - ] - }, - { - "name": "Get a blob", - "scope": "git", - "id": "getBlob", - "method": "GET", - "url": "/repos/{owner}/{repo}/git/blobs/{file_sha}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "file_sha parameter", - "enum": null, - "name": "file_sha", - "type": "string", - "required": true - } - ] - }, - { - "name": "Create a commit", - "scope": "git", - "id": "createCommit", - "method": "POST", - "url": "/repos/{owner}/{repo}/git/commits", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The commit message", - "enum": null, - "name": "message", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The SHA of the tree object this commit points to", - "enum": null, - "name": "tree", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided.", - "enum": null, - "name": "parents", - "type": "string[]", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Information about the author of the commit. By default, the `author` will be the authenticated user and the current date. See the `author` and `committer` object below for details.", - "enum": null, - "name": "author", - "type": "object", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The name of the author (or committer) of the commit", - "enum": null, - "name": "author.name", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The email of the author (or committer) of the commit", - "enum": null, - "name": "author.email", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "enum": null, - "name": "author.date", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Information about the person who is making the commit. By default, `committer` will use the information set in `author`. See the `author` and `committer` object below for details.", - "enum": null, - "name": "committer", - "type": "object", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The name of the author (or committer) of the commit", - "enum": null, - "name": "committer.name", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The email of the author (or committer) of the commit", - "enum": null, - "name": "committer.email", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "enum": null, - "name": "committer.date", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The [PGP signature](https://en.wikipedia.org/wiki/Pretty_Good_Privacy) of the commit. GitHub adds the signature to the `gpgsig` header of the created commit. For a commit signature to be verifiable by Git or GitHub, it must be an ASCII-armored detached PGP signature over the string commit as it would be written to the object database. To pass a `signature` parameter, you need to first manually create a valid PGP signature, which can be complicated. You may find it easier to [use the command line](https://git-scm.com/book/id/v2/Git-Tools-Signing-Your-Work) to create signed commits.", - "enum": null, - "name": "signature", - "type": "string", - "required": false - } - ] - }, - { - "name": "Get a commit", - "scope": "git", - "id": "getCommit", - "method": "GET", - "url": "/repos/{owner}/{repo}/git/commits/{commit_sha}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "commit_sha parameter", - "enum": null, - "name": "commit_sha", - "type": "string", - "required": true - } - ] - }, - { - "name": "List matching references", - "scope": "git", - "id": "listMatchingRefs", - "method": "GET", - "url": "/repos/{owner}/{repo}/git/matching-refs/{ref}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "ref parameter", - "enum": null, - "name": "ref", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Get a single reference", - "scope": "git", - "id": "getRef", - "method": "GET", - "url": "/repos/{owner}/{repo}/git/ref/{ref}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "ref parameter", - "enum": null, - "name": "ref", - "type": "string", - "required": true - } - ] - }, - { - "name": "Create a reference", - "scope": "git", - "id": "createRef", - "method": "POST", - "url": "/repos/{owner}/{repo}/git/refs", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The name of the fully qualified reference (ie: `refs/heads/master`). If it doesn't start with 'refs' and have at least two slashes, it will be rejected.", - "enum": null, - "name": "ref", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The SHA1 value for this reference.", - "enum": null, - "name": "sha", - "type": "string", - "required": true - } - ] - }, - { - "name": "Update a reference", - "scope": "git", - "id": "updateRef", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/git/refs/{ref}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "ref parameter", - "enum": null, - "name": "ref", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The SHA1 value to set this reference to", - "enum": null, - "name": "sha", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to `false` will make sure you're not overwriting work.", - "enum": null, - "name": "force", - "type": "boolean", - "required": false - } - ] - }, - { - "name": "Delete a reference", - "scope": "git", - "id": "deleteRef", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/git/refs/{ref}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "ref parameter", - "enum": null, - "name": "ref", - "type": "string", - "required": true - } - ] - }, - { - "name": "Create a tag object", - "scope": "git", - "id": "createTag", - "method": "POST", - "url": "/repos/{owner}/{repo}/git/tags", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The tag's name. This is typically a version (e.g., \"v0.0.1\").", - "enum": null, - "name": "tag", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The tag message.", - "enum": null, - "name": "message", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The SHA of the git object this is tagging.", - "enum": null, - "name": "object", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The type of the object we're tagging. Normally this is a `commit` but it can also be a `tree` or a `blob`.", - "enum": ["commit", "tree", "blob"], - "name": "type", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "An object with information about the individual creating the tag.", - "enum": null, - "name": "tagger", - "type": "object", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The name of the author of the tag", - "enum": null, - "name": "tagger.name", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The email of the author of the tag", - "enum": null, - "name": "tagger.email", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "When this object was tagged. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "enum": null, - "name": "tagger.date", - "type": "string", - "required": false - } - ] - }, - { - "name": "Get a tag", - "scope": "git", - "id": "getTag", - "method": "GET", - "url": "/repos/{owner}/{repo}/git/tags/{tag_sha}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "tag_sha parameter", - "enum": null, - "name": "tag_sha", - "type": "string", - "required": true - } - ] - }, - { - "name": "Create a tree", - "scope": "git", - "id": "createTree", - "method": "POST", - "url": "/repos/{owner}/{repo}/git/trees", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Objects (of `path`, `mode`, `type`, and `sha`) specifying a tree structure.", - "enum": null, - "name": "tree", - "type": "object[]", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The file referenced in the tree.", - "enum": null, - "name": "tree[].path", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The file mode; one of `100644` for file (blob), `100755` for executable (blob), `040000` for subdirectory (tree), `160000` for submodule (commit), or `120000` for a blob that specifies the path of a symlink.", - "enum": ["100644", "100755", "040000", "160000", "120000"], - "name": "tree[].mode", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Either `blob`, `tree`, or `commit`.", - "enum": ["blob", "tree", "commit"], - "name": "tree[].type", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The SHA1 checksum ID of the object in the tree. Also called `tree.sha`. \n \n**Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error.", - "enum": null, - "name": "tree[].sha", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or `tree.sha`. \n \n**Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error.", - "enum": null, - "name": "tree[].content", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The SHA1 of the tree you want to update with new data. If you don't set this, the commit will be created on top of everything; however, it will only contain your change, the rest of your files will show up as deleted.", - "enum": null, - "name": "base_tree", - "type": "string", - "required": false - } - ] - }, - { - "name": "Get a tree", - "scope": "git", - "id": "getTree", - "method": "GET", - "url": "/repos/{owner}/{repo}/git/trees/{tree_sha}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "tree_sha parameter", - "enum": null, - "name": "tree_sha", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "recursive parameter", - "enum": ["1"], - "name": "recursive", - "type": "integer", - "required": false - } - ] - }, - { - "name": "List hooks", - "scope": "repos", - "id": "listHooks", - "method": "GET", - "url": "/repos/{owner}/{repo}/hooks", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Create a hook", - "scope": "repos", - "id": "createHook", - "method": "POST", - "url": "/repos/{owner}/{repo}/hooks", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Use `web` to create a webhook. Default: `web`. This parameter only accepts the value `web`.", - "enum": null, - "name": "name", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/v3/repos/hooks/#create-hook-config-params).", - "enum": null, - "name": "config", - "type": "object", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The URL to which the payloads will be delivered.", - "enum": null, - "name": "config.url", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "enum": null, - "name": "config.content_type", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://developer.github.com/webhooks/#delivery-headers) header.", - "enum": null, - "name": "config.secret", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "enum": null, - "name": "config.insecure_ssl", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Determines what [events](https://developer.github.com/v3/activity/events/types/) the hook is triggered for.", - "enum": null, - "name": "events", - "type": "string[]", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", - "enum": null, - "name": "active", - "type": "boolean", - "required": false - } - ] - }, - { - "name": "Get single hook", - "scope": "repos", - "id": "getHook", - "method": "GET", - "url": "/repos/{owner}/{repo}/hooks/{hook_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "hook_id parameter", - "enum": null, - "name": "hook_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Edit a hook", - "scope": "repos", - "id": "updateHook", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/hooks/{hook_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "hook_id parameter", - "enum": null, - "name": "hook_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/v3/repos/hooks/#create-hook-config-params).", - "enum": null, - "name": "config", - "type": "object", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The URL to which the payloads will be delivered.", - "enum": null, - "name": "config.url", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "enum": null, - "name": "config.content_type", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://developer.github.com/webhooks/#delivery-headers) header.", - "enum": null, - "name": "config.secret", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "enum": null, - "name": "config.insecure_ssl", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Determines what [events](https://developer.github.com/v3/activity/events/types/) the hook is triggered for. This replaces the entire array of events.", - "enum": null, - "name": "events", - "type": "string[]", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Determines a list of events to be added to the list of events that the Hook triggers for.", - "enum": null, - "name": "add_events", - "type": "string[]", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Determines a list of events to be removed from the list of events that the Hook triggers for.", - "enum": null, - "name": "remove_events", - "type": "string[]", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", - "enum": null, - "name": "active", - "type": "boolean", - "required": false - } - ] - }, - { - "name": "Delete a hook", - "scope": "repos", - "id": "deleteHook", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/hooks/{hook_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "hook_id parameter", - "enum": null, - "name": "hook_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Ping a hook", - "scope": "repos", - "id": "pingHook", - "method": "POST", - "url": "/repos/{owner}/{repo}/hooks/{hook_id}/pings", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "hook_id parameter", - "enum": null, - "name": "hook_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Test a push hook", - "scope": "repos", - "id": "testPushHook", - "method": "POST", - "url": "/repos/{owner}/{repo}/hooks/{hook_id}/tests", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "hook_id parameter", - "enum": null, - "name": "hook_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Start an import", - "scope": "migrations", - "id": "startImport", - "method": "PUT", - "url": "/repos/{owner}/{repo}/import", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The URL of the originating repository.", - "enum": null, - "name": "vcs_url", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The originating VCS type. Can be one of `subversion`, `git`, `mercurial`, or `tfvc`. Please be aware that without this parameter, the import job will take additional time to detect the VCS type before beginning the import. This detection step will be reflected in the response.", - "enum": ["subversion", "git", "mercurial", "tfvc"], - "name": "vcs", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "If authentication is required, the username to provide to `vcs_url`.", - "enum": null, - "name": "vcs_username", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "If authentication is required, the password to provide to `vcs_url`.", - "enum": null, - "name": "vcs_password", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "For a tfvc import, the name of the project that is being imported.", - "enum": null, - "name": "tfvc_project", - "type": "string", - "required": false - } - ] - }, - { - "name": "Get import progress", - "scope": "migrations", - "id": "getImportProgress", - "method": "GET", - "url": "/repos/{owner}/{repo}/import", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - } - ] - }, - { - "name": "Update existing import", - "scope": "migrations", - "id": "updateImport", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/import", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The username to provide to the originating repository.", - "enum": null, - "name": "vcs_username", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The password to provide to the originating repository.", - "enum": null, - "name": "vcs_password", - "type": "string", - "required": false - } - ] - }, - { - "name": "Cancel an import", - "scope": "migrations", - "id": "cancelImport", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/import", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - } - ] - }, - { - "name": "Get commit authors", - "scope": "migrations", - "id": "getCommitAuthors", - "method": "GET", - "url": "/repos/{owner}/{repo}/import/authors", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Only authors found after this id are returned. Provide the highest author ID you've seen so far. New authors may be added to the list at any point while the importer is performing the `raw` step.", - "enum": null, - "name": "since", - "type": "string", - "required": false - } - ] - }, - { - "name": "Map a commit author", - "scope": "migrations", - "id": "mapCommitAuthor", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/import/authors/{author_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "author_id parameter", - "enum": null, - "name": "author_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The new Git author email.", - "enum": null, - "name": "email", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The new Git author name.", - "enum": null, - "name": "name", - "type": "string", - "required": false - } - ] - }, - { - "name": "Get large files", - "scope": "migrations", - "id": "getLargeFiles", - "method": "GET", - "url": "/repos/{owner}/{repo}/import/large_files", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - } - ] - }, - { - "name": "Set Git LFS preference", - "scope": "migrations", - "id": "setLfsPreference", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/import/lfs", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Can be one of `opt_in` (large files will be stored using Git LFS) or `opt_out` (large files will be removed during the import).", - "enum": ["opt_in", "opt_out"], - "name": "use_lfs", - "type": "string", - "required": true - } - ] - }, - { - "name": "Get a repository installation", - "scope": "apps", - "id": "getRepoInstallation", - "method": "GET", - "url": "/repos/{owner}/{repo}/installation", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - } - ] - }, - { - "name": "Get a repository installation", - "scope": "apps", - "id": "findRepoInstallation", - "method": "GET", - "url": "/repos/{owner}/{repo}/installation", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - } - ] - }, - { - "name": "Get interaction restrictions for a repository", - "scope": "interactions", - "id": "getRestrictionsForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/interaction-limits", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - } - ] - }, - { - "name": "Add or update interaction restrictions for a repository", - "scope": "interactions", - "id": "addOrUpdateRestrictionsForRepo", - "method": "PUT", - "url": "/repos/{owner}/{repo}/interaction-limits", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Specifies the group of GitHub users who can comment, open issues, or create pull requests for the given repository. Must be one of: `existing_users`, `contributors_only`, or `collaborators_only`.", - "enum": ["existing_users", "contributors_only", "collaborators_only"], - "name": "limit", - "type": "string", - "required": true - } - ] - }, - { - "name": "Remove interaction restrictions for a repository", - "scope": "interactions", - "id": "removeRestrictionsForRepo", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/interaction-limits", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - } - ] - }, - { - "name": "List invitations for a repository", - "scope": "repos", - "id": "listInvitations", - "method": "GET", - "url": "/repos/{owner}/{repo}/invitations", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Delete a repository invitation", - "scope": "repos", - "id": "deleteInvitation", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/invitations/{invitation_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "invitation_id parameter", - "enum": null, - "name": "invitation_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Update a repository invitation", - "scope": "repos", - "id": "updateInvitation", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/invitations/{invitation_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "invitation_id parameter", - "enum": null, - "name": "invitation_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The permissions that the associated user will have on the repository. Valid values are `read`, `write`, and `admin`.", - "enum": ["read", "write", "admin"], - "name": "permissions", - "type": "string", - "required": false - } - ] - }, - { - "name": "List issues for a repository", - "scope": "issues", - "id": "listForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/issues", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "If an `integer` is passed, it should refer to a milestone by its `number` field. If the string `*` is passed, issues with any milestone are accepted. If the string `none` is passed, issues without milestones are returned.", - "enum": null, - "name": "milestone", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.", - "enum": ["open", "closed", "all"], - "name": "state", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Can be the name of a user. Pass in `none` for issues with no assigned user, and `*` for issues assigned to any user.", - "enum": null, - "name": "assignee", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The user that created the issue.", - "enum": null, - "name": "creator", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A user that's mentioned in the issue.", - "enum": null, - "name": "mentioned", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A list of comma separated label names. Example: `bug,ui,@high`", - "enum": null, - "name": "labels", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "What to sort results by. Can be either `created`, `updated`, `comments`.", - "enum": ["created", "updated", "comments"], - "name": "sort", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The direction of the sort. Can be either `asc` or `desc`.", - "enum": ["asc", "desc"], - "name": "direction", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Only issues updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "enum": null, - "name": "since", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Create an issue", - "scope": "issues", - "id": "create", - "method": "POST", - "url": "/repos/{owner}/{repo}/issues", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The title of the issue.", - "enum": null, - "name": "title", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The contents of the issue.", - "enum": null, - "name": "body", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is deprecated.**_", - "enum": null, - "name": "assignee", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The `number` of the milestone to associate this issue with. _NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise._", - "enum": null, - "name": "milestone", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._", - "enum": null, - "name": "labels", - "type": "string[]", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._", - "enum": null, - "name": "assignees", - "type": "string[]", - "required": false - } - ] - }, - { - "name": "List comments in a repository", - "scope": "issues", - "id": "listCommentsForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/issues/comments", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Either `created` or `updated`.", - "enum": ["created", "updated"], - "name": "sort", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Either `asc` or `desc`. Ignored without the `sort` parameter.", - "enum": ["asc", "desc"], - "name": "direction", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Only comments updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "enum": null, - "name": "since", - "type": "string", - "required": false - } - ] - }, - { - "name": "Get a single comment", - "scope": "issues", - "id": "getComment", - "method": "GET", - "url": "/repos/{owner}/{repo}/issues/comments/{comment_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "comment_id parameter", - "enum": null, - "name": "comment_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Edit a comment", - "scope": "issues", - "id": "updateComment", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/issues/comments/{comment_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "comment_id parameter", - "enum": null, - "name": "comment_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The contents of the comment.", - "enum": null, - "name": "body", - "type": "string", - "required": true - } - ] - }, - { - "name": "Delete a comment", - "scope": "issues", - "id": "deleteComment", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/issues/comments/{comment_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "comment_id parameter", - "enum": null, - "name": "comment_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "List reactions for an issue comment", - "scope": "reactions", - "id": "listForIssueComment", - "method": "GET", - "url": "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "comment_id parameter", - "enum": null, - "name": "comment_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to an issue comment.", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "name": "content", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Create reaction for an issue comment", - "scope": "reactions", - "id": "createForIssueComment", - "method": "POST", - "url": "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "comment_id parameter", - "enum": null, - "name": "comment_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the issue comment.", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "name": "content", - "type": "string", - "required": true - } - ] - }, - { - "name": "List events for a repository", - "scope": "issues", - "id": "listEventsForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/issues/events", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Get a single event", - "scope": "issues", - "id": "getEvent", - "method": "GET", - "url": "/repos/{owner}/{repo}/issues/events/{event_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "event_id parameter", - "enum": null, - "name": "event_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Get a single issue", - "scope": "issues", - "id": "get", - "method": "GET", - "url": "/repos/{owner}/{repo}/issues/{issue_number}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "issue_number parameter", - "enum": null, - "name": "issue_number", - "type": "integer", - "required": true - }, - { - "alias": "issue_number", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "number", - "type": null, - "required": null - } - ] - }, - { - "name": "Edit an issue", - "scope": "issues", - "id": "update", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/issues/{issue_number}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "issue_number parameter", - "enum": null, - "name": "issue_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The title of the issue.", - "enum": null, - "name": "title", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The contents of the issue.", - "enum": null, - "name": "body", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Login for the user that this issue should be assigned to. **This field is deprecated.**", - "enum": null, - "name": "assignee", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "State of the issue. Either `open` or `closed`.", - "enum": ["open", "closed"], - "name": "state", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": true, - "deprecated": null, - "description": "The `number` of the milestone to associate this issue with or `null` to remove current. _NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise._", - "enum": null, - "name": "milestone", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Labels to associate with this issue. Pass one or more Labels to _replace_ the set of Labels on this Issue. Send an empty array (`[]`) to clear all Labels from the Issue. _NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise._", - "enum": null, - "name": "labels", - "type": "string[]", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Logins for Users to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this Issue. Send an empty array (`[]`) to clear all assignees from the Issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._", - "enum": null, - "name": "assignees", - "type": "string[]", - "required": false - }, - { - "alias": "issue_number", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "number", - "type": null, - "required": null - } - ] - }, - { - "name": "Add assignees to an issue", - "scope": "issues", - "id": "addAssignees", - "method": "POST", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/assignees", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "issue_number parameter", - "enum": null, - "name": "issue_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Usernames of people to assign this issue to. _NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise._", - "enum": null, - "name": "assignees", - "type": "string[]", - "required": false - }, - { - "alias": "issue_number", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "number", - "type": null, - "required": null - } - ] - }, - { - "name": "Remove assignees from an issue", - "scope": "issues", - "id": "removeAssignees", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/assignees", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "issue_number parameter", - "enum": null, - "name": "issue_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Usernames of assignees to remove from an issue. _NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise._", - "enum": null, - "name": "assignees", - "type": "string[]", - "required": false - }, - { - "alias": "issue_number", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "number", - "type": null, - "required": null - } - ] - }, - { - "name": "List comments on an issue", - "scope": "issues", - "id": "listComments", - "method": "GET", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/comments", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "issue_number parameter", - "enum": null, - "name": "issue_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Only comments updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "enum": null, - "name": "since", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - }, - { - "alias": "issue_number", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "number", - "type": null, - "required": null - } - ] - }, - { - "name": "Create a comment", - "scope": "issues", - "id": "createComment", - "method": "POST", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/comments", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "issue_number parameter", - "enum": null, - "name": "issue_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The contents of the comment.", - "enum": null, - "name": "body", - "type": "string", - "required": true - }, - { - "alias": "issue_number", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "number", - "type": null, - "required": null - } - ] - }, - { - "name": "List events for an issue", - "scope": "issues", - "id": "listEvents", - "method": "GET", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/events", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "issue_number parameter", - "enum": null, - "name": "issue_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - }, - { - "alias": "issue_number", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "number", - "type": null, - "required": null - } - ] - }, - { - "name": "List labels on an issue", - "scope": "issues", - "id": "listLabelsOnIssue", - "method": "GET", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/labels", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "issue_number parameter", - "enum": null, - "name": "issue_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - }, - { - "alias": "issue_number", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "number", - "type": null, - "required": null - } - ] - }, - { - "name": "Add labels to an issue", - "scope": "issues", - "id": "addLabels", - "method": "POST", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/labels", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "issue_number parameter", - "enum": null, - "name": "issue_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The name of the label to add to the issue. Must contain at least one label. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key.", - "enum": null, - "name": "labels", - "type": "string[]", - "required": true - }, - { - "alias": "issue_number", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "number", - "type": null, - "required": null - } - ] - }, - { - "name": "Replace all labels for an issue", - "scope": "issues", - "id": "replaceLabels", - "method": "PUT", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/labels", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "issue_number parameter", - "enum": null, - "name": "issue_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The names of the labels to add to the issue. You can pass an empty array to remove all labels. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key.", - "enum": null, - "name": "labels", - "type": "string[]", - "required": false - }, - { - "alias": "issue_number", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "number", - "type": null, - "required": null - } - ] - }, - { - "name": "Remove all labels from an issue", - "scope": "issues", - "id": "removeLabels", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/labels", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "issue_number parameter", - "enum": null, - "name": "issue_number", - "type": "integer", - "required": true - }, - { - "alias": "issue_number", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "number", - "type": null, - "required": null - } - ] - }, - { - "name": "Remove a label from an issue", - "scope": "issues", - "id": "removeLabel", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/labels/{name}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "issue_number parameter", - "enum": null, - "name": "issue_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "name parameter", - "enum": null, - "name": "name", - "type": "string", - "required": true - }, - { - "alias": "issue_number", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "number", - "type": null, - "required": null - } - ] - }, - { - "name": "Lock an issue", - "scope": "issues", - "id": "lock", - "method": "PUT", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/lock", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "issue_number parameter", - "enum": null, - "name": "issue_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: \n\\* `off-topic` \n\\* `too heated` \n\\* `resolved` \n\\* `spam`", - "enum": ["off-topic", "too heated", "resolved", "spam"], - "name": "lock_reason", - "type": "string", - "required": false - }, - { - "alias": "issue_number", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "number", - "type": null, - "required": null - } - ] - }, - { - "name": "Unlock an issue", - "scope": "issues", - "id": "unlock", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/lock", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "issue_number parameter", - "enum": null, - "name": "issue_number", - "type": "integer", - "required": true - }, - { - "alias": "issue_number", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "number", - "type": null, - "required": null - } - ] - }, - { - "name": "List reactions for an issue", - "scope": "reactions", - "id": "listForIssue", - "method": "GET", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/reactions", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "issue_number parameter", - "enum": null, - "name": "issue_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to an issue.", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "name": "content", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - }, - { - "alias": "issue_number", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "number", - "type": null, - "required": null - } - ] - }, - { - "name": "Create reaction for an issue", - "scope": "reactions", - "id": "createForIssue", - "method": "POST", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/reactions", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "issue_number parameter", - "enum": null, - "name": "issue_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the issue.", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "name": "content", - "type": "string", - "required": true - }, - { - "alias": "issue_number", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "number", - "type": null, - "required": null - } - ] - }, - { - "name": "List events for an issue", - "scope": "issues", - "id": "listEventsForTimeline", - "method": "GET", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/timeline", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "issue_number parameter", - "enum": null, - "name": "issue_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - }, - { - "alias": "issue_number", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "number", - "type": null, - "required": null - } - ] - }, - { - "name": "List deploy keys", - "scope": "repos", - "id": "listDeployKeys", - "method": "GET", - "url": "/repos/{owner}/{repo}/keys", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Add a new deploy key", - "scope": "repos", - "id": "addDeployKey", - "method": "POST", - "url": "/repos/{owner}/{repo}/keys", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A name for the key.", - "enum": null, - "name": "title", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The contents of the key.", - "enum": null, - "name": "key", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. \n \nDeploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"[Repository permission levels for an organization](https://help.github.com/articles/repository-permission-levels-for-an-organization/)\" and \"[Permission levels for a user account repository](https://help.github.com/articles/permission-levels-for-a-user-account-repository/).\"", - "enum": null, - "name": "read_only", - "type": "boolean", - "required": false - } - ] - }, - { - "name": "Get a deploy key", - "scope": "repos", - "id": "getDeployKey", - "method": "GET", - "url": "/repos/{owner}/{repo}/keys/{key_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "key_id parameter", - "enum": null, - "name": "key_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Remove a deploy key", - "scope": "repos", - "id": "removeDeployKey", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/keys/{key_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "key_id parameter", - "enum": null, - "name": "key_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "List all labels for this repository", - "scope": "issues", - "id": "listLabelsForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/labels", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Create a label", - "scope": "issues", - "id": "createLabel", - "method": "POST", - "url": "/repos/{owner}/{repo}/labels", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png \":strawberry:\"). For a full list of available emoji and codes, see [emoji-cheat-sheet.com](http://emoji-cheat-sheet.com/).", - "enum": null, - "name": "name", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`.", - "enum": null, - "name": "color", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A short description of the label.", - "enum": null, - "name": "description", - "type": "string", - "required": false - } - ] - }, - { - "name": "Get a single label", - "scope": "issues", - "id": "getLabel", - "method": "GET", - "url": "/repos/{owner}/{repo}/labels/{name}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "name parameter", - "enum": null, - "name": "name", - "type": "string", - "required": true - } - ] - }, - { - "name": "Update a label", - "scope": "issues", - "id": "updateLabel", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/labels/{name}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "name parameter", - "enum": null, - "name": "name", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png \":strawberry:\"). For a full list of available emoji and codes, see [emoji-cheat-sheet.com](http://emoji-cheat-sheet.com/).", - "enum": null, - "name": "new_name", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`.", - "enum": null, - "name": "color", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A short description of the label.", - "enum": null, - "name": "description", - "type": "string", - "required": false - } - ] - }, - { - "name": "Delete a label", - "scope": "issues", - "id": "deleteLabel", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/labels/{name}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "name parameter", - "enum": null, - "name": "name", - "type": "string", - "required": true - } - ] - }, - { - "name": "List languages", - "scope": "repos", - "id": "listLanguages", - "method": "GET", - "url": "/repos/{owner}/{repo}/languages", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - } - ] - }, - { - "name": "Get the contents of a repository's license", - "scope": "licenses", - "id": "getForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/license", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - } - ] - }, - { - "name": "Perform a merge", - "scope": "repos", - "id": "merge", - "method": "POST", - "url": "/repos/{owner}/{repo}/merges", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The name of the base branch that the head will be merged into.", - "enum": null, - "name": "base", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The head to merge. This can be a branch name or a commit SHA1.", - "enum": null, - "name": "head", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Commit message to use for the merge commit. If omitted, a default message will be used.", - "enum": null, - "name": "commit_message", - "type": "string", - "required": false - } - ] - }, - { - "name": "List milestones for a repository", - "scope": "issues", - "id": "listMilestonesForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/milestones", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The state of the milestone. Either `open`, `closed`, or `all`.", - "enum": ["open", "closed", "all"], - "name": "state", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "What to sort results by. Either `due_on` or `completeness`.", - "enum": ["due_on", "completeness"], - "name": "sort", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The direction of the sort. Either `asc` or `desc`.", - "enum": ["asc", "desc"], - "name": "direction", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Create a milestone", - "scope": "issues", - "id": "createMilestone", - "method": "POST", - "url": "/repos/{owner}/{repo}/milestones", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The title of the milestone.", - "enum": null, - "name": "title", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The state of the milestone. Either `open` or `closed`.", - "enum": ["open", "closed"], - "name": "state", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A description of the milestone.", - "enum": null, - "name": "description", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "enum": null, - "name": "due_on", - "type": "string", - "required": false - } - ] - }, - { - "name": "Get a single milestone", - "scope": "issues", - "id": "getMilestone", - "method": "GET", - "url": "/repos/{owner}/{repo}/milestones/{milestone_number}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "milestone_number parameter", - "enum": null, - "name": "milestone_number", - "type": "integer", - "required": true - }, - { - "alias": "milestone_number", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "number", - "type": null, - "required": null - } - ] - }, - { - "name": "Update a milestone", - "scope": "issues", - "id": "updateMilestone", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/milestones/{milestone_number}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "milestone_number parameter", - "enum": null, - "name": "milestone_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The title of the milestone.", - "enum": null, - "name": "title", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The state of the milestone. Either `open` or `closed`.", - "enum": ["open", "closed"], - "name": "state", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A description of the milestone.", - "enum": null, - "name": "description", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "enum": null, - "name": "due_on", - "type": "string", - "required": false - }, - { - "alias": "milestone_number", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "number", - "type": null, - "required": null - } - ] - }, - { - "name": "Delete a milestone", - "scope": "issues", - "id": "deleteMilestone", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/milestones/{milestone_number}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "milestone_number parameter", - "enum": null, - "name": "milestone_number", - "type": "integer", - "required": true - }, - { - "alias": "milestone_number", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "number", - "type": null, - "required": null - } - ] - }, - { - "name": "Get labels for every issue in a milestone", - "scope": "issues", - "id": "listLabelsForMilestone", - "method": "GET", - "url": "/repos/{owner}/{repo}/milestones/{milestone_number}/labels", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "milestone_number parameter", - "enum": null, - "name": "milestone_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - }, - { - "alias": "milestone_number", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "number", - "type": null, - "required": null - } - ] - }, - { - "name": "List your notifications in a repository", - "scope": "activity", - "id": "listNotificationsForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/notifications", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "If `true`, show notifications marked as read.", - "enum": null, - "name": "all", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "If `true`, only shows notifications in which the user is directly participating or mentioned.", - "enum": null, - "name": "participating", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "enum": null, - "name": "since", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "enum": null, - "name": "before", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Mark notifications as read in a repository", - "scope": "activity", - "id": "markNotificationsAsReadForRepo", - "method": "PUT", - "url": "/repos/{owner}/{repo}/notifications", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Describes the last point that notifications were checked. Anything updated since this time will not be updated. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp.", - "enum": null, - "name": "last_read_at", - "type": "string", - "required": false - } - ] - }, - { - "name": "Get information about a Pages site", - "scope": "repos", - "id": "getPages", - "method": "GET", - "url": "/repos/{owner}/{repo}/pages", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - } - ] - }, - { - "name": "Enable a Pages site", - "scope": "repos", - "id": "enablePagesSite", - "method": "POST", - "url": "/repos/{owner}/{repo}/pages", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "source parameter", - "enum": null, - "name": "source", - "type": "object", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The repository branch used to publish your [site's source files](https://help.github.com/articles/configuring-a-publishing-source-for-github-pages/). Can be either `master` or `gh-pages`.", - "enum": ["master", "gh-pages"], - "name": "source.branch", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The repository directory that includes the source files for the Pages site. When `branch` is `master`, you can change `path` to `/docs`. When `branch` is `gh-pages`, you are unable to specify a `path` other than `/`.", - "enum": null, - "name": "source.path", - "type": "string", - "required": false - } - ] - }, - { - "name": "Disable a Pages site", - "scope": "repos", - "id": "disablePagesSite", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/pages", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - } - ] - }, - { - "name": "Update information about a Pages site", - "scope": "repos", - "id": "updateInformationAboutPagesSite", - "method": "PUT", - "url": "/repos/{owner}/{repo}/pages", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see \"[Using a custom domain with GitHub Pages](https://help.github.com/articles/using-a-custom-domain-with-github-pages/).\"", - "enum": null, - "name": "cname", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Update the source for the repository. Must include the branch name, and may optionally specify the subdirectory `/docs`. Possible values are `\"gh-pages\"`, `\"master\"`, and `\"master /docs\"`.", - "enum": ["\"gh-pages\"", "\"master\"", "\"master /docs\""], - "name": "source", - "type": "string", - "required": false - } - ] - }, - { - "name": "Request a page build", - "scope": "repos", - "id": "requestPageBuild", - "method": "POST", - "url": "/repos/{owner}/{repo}/pages/builds", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - } - ] - }, - { - "name": "List Pages builds", - "scope": "repos", - "id": "listPagesBuilds", - "method": "GET", - "url": "/repos/{owner}/{repo}/pages/builds", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Get latest Pages build", - "scope": "repos", - "id": "getLatestPagesBuild", - "method": "GET", - "url": "/repos/{owner}/{repo}/pages/builds/latest", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - } - ] - }, - { - "name": "Get a specific Pages build", - "scope": "repos", - "id": "getPagesBuild", - "method": "GET", - "url": "/repos/{owner}/{repo}/pages/builds/{build_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "build_id parameter", - "enum": null, - "name": "build_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "List repository projects", - "scope": "projects", - "id": "listForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/projects", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`.", - "enum": ["open", "closed", "all"], - "name": "state", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Create a repository project", - "scope": "projects", - "id": "createForRepo", - "method": "POST", - "url": "/repos/{owner}/{repo}/projects", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The name of the project.", - "enum": null, - "name": "name", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The description of the project.", - "enum": null, - "name": "body", - "type": "string", - "required": false - } - ] - }, - { - "name": "List pull requests", - "scope": "pulls", - "id": "list", - "method": "GET", - "url": "/repos/{owner}/{repo}/pulls", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Either `open`, `closed`, or `all` to filter by state.", - "enum": ["open", "closed", "all"], - "name": "state", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Filter pulls by head user or head organization and branch name in the format of `user:ref-name` or `organization:ref-name`. For example: `github:new-script-format` or `octocat:test-branch`.", - "enum": null, - "name": "head", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Filter pulls by base branch name. Example: `gh-pages`.", - "enum": null, - "name": "base", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "What to sort results by. Can be either `created`, `updated`, `popularity` (comment count) or `long-running` (age, filtering by pulls updated in the last month).", - "enum": ["created", "updated", "popularity", "long-running"], - "name": "sort", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The direction of the sort. Can be either `asc` or `desc`. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`.", - "enum": ["asc", "desc"], - "name": "direction", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Create a pull request", - "scope": "pulls", - "id": "create", - "method": "POST", - "url": "/repos/{owner}/{repo}/pulls", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The title of the new pull request.", - "enum": null, - "name": "title", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace `head` with a user like this: `username:branch`.", - "enum": null, - "name": "head", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository.", - "enum": null, - "name": "base", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The contents of the pull request.", - "enum": null, - "name": "body", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Indicates whether [maintainers can modify](https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request.", - "enum": null, - "name": "maintainer_can_modify", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Indicates whether the pull request is a draft. See \"[Draft Pull Requests](https://help.github.com/en/articles/about-pull-requests#draft-pull-requests)\" in the GitHub Help documentation to learn more.", - "enum": null, - "name": "draft", - "type": "boolean", - "required": false - } - ] - }, - { - "name": "List comments in a repository", - "scope": "pulls", - "id": "listCommentsForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/pulls/comments", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Can be either `created` or `updated` comments.", - "enum": ["created", "updated"], - "name": "sort", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Can be either `asc` or `desc`. Ignored without `sort` parameter.", - "enum": ["asc", "desc"], - "name": "direction", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only returns comments `updated` at or after this time.", - "enum": null, - "name": "since", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Get a single comment", - "scope": "pulls", - "id": "getComment", - "method": "GET", - "url": "/repos/{owner}/{repo}/pulls/comments/{comment_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "comment_id parameter", - "enum": null, - "name": "comment_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Edit a comment", - "scope": "pulls", - "id": "updateComment", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/pulls/comments/{comment_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "comment_id parameter", - "enum": null, - "name": "comment_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The text of the reply to the review comment.", - "enum": null, - "name": "body", - "type": "string", - "required": true - } - ] - }, - { - "name": "Delete a comment", - "scope": "pulls", - "id": "deleteComment", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/pulls/comments/{comment_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "comment_id parameter", - "enum": null, - "name": "comment_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "List reactions for a pull request review comment", - "scope": "reactions", - "id": "listForPullRequestReviewComment", - "method": "GET", - "url": "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "comment_id parameter", - "enum": null, - "name": "comment_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a pull request review comment.", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "name": "content", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Create reaction for a pull request review comment", - "scope": "reactions", - "id": "createForPullRequestReviewComment", - "method": "POST", - "url": "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "comment_id parameter", - "enum": null, - "name": "comment_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the pull request review comment.", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "name": "content", - "type": "string", - "required": true - } - ] - }, - { - "name": "Get a single pull request", - "scope": "pulls", - "id": "get", - "method": "GET", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "pull_number parameter", - "enum": null, - "name": "pull_number", - "type": "integer", - "required": true - }, - { - "alias": "pull_number", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "number", - "type": null, - "required": null - } - ] - }, - { - "name": "Update a pull request", - "scope": "pulls", - "id": "update", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "pull_number parameter", - "enum": null, - "name": "pull_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The title of the pull request.", - "enum": null, - "name": "title", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The contents of the pull request.", - "enum": null, - "name": "body", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "State of this Pull Request. Either `open` or `closed`.", - "enum": ["open", "closed"], - "name": "state", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository.", - "enum": null, - "name": "base", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Indicates whether [maintainers can modify](https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request.", - "enum": null, - "name": "maintainer_can_modify", - "type": "boolean", - "required": false - }, - { - "alias": "pull_number", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "number", - "type": null, - "required": null - } - ] - }, - { - "name": "List comments on a pull request", - "scope": "pulls", - "id": "listComments", - "method": "GET", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/comments", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "pull_number parameter", - "enum": null, - "name": "pull_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Can be either `created` or `updated` comments.", - "enum": ["created", "updated"], - "name": "sort", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Can be either `asc` or `desc`. Ignored without `sort` parameter.", - "enum": ["asc", "desc"], - "name": "direction", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only returns comments `updated` at or after this time.", - "enum": null, - "name": "since", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - }, - { - "alias": "pull_number", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "number", - "type": null, - "required": null - } - ] - }, - { - "name": "Create a comment", - "scope": "pulls", - "id": "createComment", - "method": "POST", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/comments", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "pull_number parameter", - "enum": null, - "name": "pull_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The text of the review comment.", - "enum": null, - "name": "body", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the `position`.", - "enum": null, - "name": "commit_id", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The relative path to the file that necessitates a comment.", - "enum": null, - "name": "path", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "**Required without `comfort-fade` preview**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.", - "enum": null, - "name": "position", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "**Required with `comfort-fade` preview**. In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://help.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.", - "enum": ["LEFT", "RIGHT"], - "name": "side", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "**Required with `comfort-fade` preview**. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.", - "enum": null, - "name": "line", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "**Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation.", - "enum": null, - "name": "start_line", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "**Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.", - "enum": ["LEFT", "RIGHT", "side"], - "name": "start_side", - "type": "string", - "required": false - }, - { - "alias": "pull_number", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "number", - "type": null, - "required": null - }, - { - "alias": null, - "allowNull": null, - "deprecated": true, - "description": "The comment ID to reply to. **Note**: This must be the ID of a top-level comment, not a reply to that comment. Replies to replies are not supported.", - "enum": null, - "name": "in_reply_to", - "type": "integer", - "required": null - } - ] - }, - { - "name": "Create a comment", - "scope": "pulls", - "id": "createCommentReply", - "method": "POST", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/comments", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "pull_number parameter", - "enum": null, - "name": "pull_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The text of the review comment.", - "enum": null, - "name": "body", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the `position`.", - "enum": null, - "name": "commit_id", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The relative path to the file that necessitates a comment.", - "enum": null, - "name": "path", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "**Required without `comfort-fade` preview**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.", - "enum": null, - "name": "position", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "**Required with `comfort-fade` preview**. In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://help.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.", - "enum": ["LEFT", "RIGHT"], - "name": "side", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "**Required with `comfort-fade` preview**. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.", - "enum": null, - "name": "line", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "**Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation.", - "enum": null, - "name": "start_line", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "**Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.", - "enum": ["LEFT", "RIGHT", "side"], - "name": "start_side", - "type": "string", - "required": false - }, - { - "alias": "pull_number", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "number", - "type": null, - "required": null - }, - { - "alias": null, - "allowNull": null, - "deprecated": true, - "description": "The comment ID to reply to. **Note**: This must be the ID of a top-level comment, not a reply to that comment. Replies to replies are not supported.", - "enum": null, - "name": "in_reply_to", - "type": "integer", - "required": null - } - ] - }, - { - "name": "Create a review comment reply", - "scope": "pulls", - "id": "createReviewCommentReply", - "method": "POST", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "pull_number parameter", - "enum": null, - "name": "pull_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "comment_id parameter", - "enum": null, - "name": "comment_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The text of the review comment.", - "enum": null, - "name": "body", - "type": "string", - "required": true - } - ] - }, - { - "name": "List commits on a pull request", - "scope": "pulls", - "id": "listCommits", - "method": "GET", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/commits", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "pull_number parameter", - "enum": null, - "name": "pull_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - }, - { - "alias": "pull_number", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "number", - "type": null, - "required": null - } - ] - }, - { - "name": "List pull requests files", - "scope": "pulls", - "id": "listFiles", - "method": "GET", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/files", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "pull_number parameter", - "enum": null, - "name": "pull_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - }, - { - "alias": "pull_number", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "number", - "type": null, - "required": null - } - ] - }, - { - "name": "Get if a pull request has been merged", - "scope": "pulls", - "id": "checkIfMerged", - "method": "GET", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/merge", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "pull_number parameter", - "enum": null, - "name": "pull_number", - "type": "integer", - "required": true - }, - { - "alias": "pull_number", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "number", - "type": null, - "required": null - } - ] - }, - { - "name": "Merge a pull request (Merge Button)", - "scope": "pulls", - "id": "merge", - "method": "PUT", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/merge", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "pull_number parameter", - "enum": null, - "name": "pull_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Title for the automatic commit message.", - "enum": null, - "name": "commit_title", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Extra detail to append to automatic commit message.", - "enum": null, - "name": "commit_message", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "SHA that pull request head must match to allow merge.", - "enum": null, - "name": "sha", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Merge method to use. Possible values are `merge`, `squash` or `rebase`. Default is `merge`.", - "enum": ["merge", "squash", "rebase"], - "name": "merge_method", - "type": "string", - "required": false - }, - { - "alias": "pull_number", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "number", - "type": null, - "required": null - } - ] - }, - { - "name": "List review requests", - "scope": "pulls", - "id": "listReviewRequests", - "method": "GET", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "pull_number parameter", - "enum": null, - "name": "pull_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - }, - { - "alias": "pull_number", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "number", - "type": null, - "required": null - } - ] - }, - { - "name": "Create a review request", - "scope": "pulls", - "id": "createReviewRequest", - "method": "POST", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "pull_number parameter", - "enum": null, - "name": "pull_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "An array of user `login`s that will be requested.", - "enum": null, - "name": "reviewers", - "type": "string[]", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "An array of team `slug`s that will be requested.", - "enum": null, - "name": "team_reviewers", - "type": "string[]", - "required": false - }, - { - "alias": "pull_number", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "number", - "type": null, - "required": null - } - ] - }, - { - "name": "Delete a review request", - "scope": "pulls", - "id": "deleteReviewRequest", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "pull_number parameter", - "enum": null, - "name": "pull_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "An array of user `login`s that will be removed.", - "enum": null, - "name": "reviewers", - "type": "string[]", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "An array of team `slug`s that will be removed.", - "enum": null, - "name": "team_reviewers", - "type": "string[]", - "required": false - }, - { - "alias": "pull_number", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "number", - "type": null, - "required": null - } - ] - }, - { - "name": "List reviews on a pull request", - "scope": "pulls", - "id": "listReviews", - "method": "GET", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "pull_number parameter", - "enum": null, - "name": "pull_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - }, - { - "alias": "pull_number", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "number", - "type": null, - "required": null - } - ] - }, - { - "name": "Create a pull request review", - "scope": "pulls", - "id": "createReview", - "method": "POST", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "pull_number parameter", - "enum": null, - "name": "pull_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the `position`. Defaults to the most recent commit in the pull request when you do not specify a value.", - "enum": null, - "name": "commit_id", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "**Required** when using `REQUEST_CHANGES` or `COMMENT` for the `event` parameter. The body text of the pull request review.", - "enum": null, - "name": "body", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://developer.github.com/v3/pulls/reviews/#submit-a-pull-request-review) when you are ready.", - "enum": ["APPROVE", "REQUEST_CHANGES", "COMMENT"], - "name": "event", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Use the following table to specify the location, destination, and contents of the draft review comment.", - "enum": null, - "name": "comments", - "type": "object[]", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The relative path to the file that necessitates a review comment.", - "enum": null, - "name": "comments[].path", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note below.", - "enum": null, - "name": "comments[].position", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Text of the review comment.", - "enum": null, - "name": "comments[].body", - "type": "string", - "required": true - }, - { - "alias": "pull_number", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "number", - "type": null, - "required": null - } - ] - }, - { - "name": "Get a single review", - "scope": "pulls", - "id": "getReview", - "method": "GET", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "pull_number parameter", - "enum": null, - "name": "pull_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "review_id parameter", - "enum": null, - "name": "review_id", - "type": "integer", - "required": true - }, - { - "alias": "pull_number", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "number", - "type": null, - "required": null - } - ] - }, - { - "name": "Delete a pending review", - "scope": "pulls", - "id": "deletePendingReview", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "pull_number parameter", - "enum": null, - "name": "pull_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "review_id parameter", - "enum": null, - "name": "review_id", - "type": "integer", - "required": true - }, - { - "alias": "pull_number", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "number", - "type": null, - "required": null - } - ] - }, - { - "name": "Update a pull request review", - "scope": "pulls", - "id": "updateReview", - "method": "PUT", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "pull_number parameter", - "enum": null, - "name": "pull_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "review_id parameter", - "enum": null, - "name": "review_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The body text of the pull request review.", - "enum": null, - "name": "body", - "type": "string", - "required": true - }, - { - "alias": "pull_number", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "number", - "type": null, - "required": null - } - ] - }, - { - "name": "Get comments for a single review", - "scope": "pulls", - "id": "getCommentsForReview", - "method": "GET", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "pull_number parameter", - "enum": null, - "name": "pull_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "review_id parameter", - "enum": null, - "name": "review_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - }, - { - "alias": "pull_number", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "number", - "type": null, - "required": null - } - ] - }, - { - "name": "Dismiss a pull request review", - "scope": "pulls", - "id": "dismissReview", - "method": "PUT", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "pull_number parameter", - "enum": null, - "name": "pull_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "review_id parameter", - "enum": null, - "name": "review_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The message for the pull request review dismissal", - "enum": null, - "name": "message", - "type": "string", - "required": true - }, - { - "alias": "pull_number", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "number", - "type": null, - "required": null - } - ] - }, - { - "name": "Submit a pull request review", - "scope": "pulls", - "id": "submitReview", - "method": "POST", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "pull_number parameter", - "enum": null, - "name": "pull_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "review_id parameter", - "enum": null, - "name": "review_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The body text of the pull request review", - "enum": null, - "name": "body", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. When you leave this blank, the API returns _HTTP 422 (Unrecognizable entity)_ and sets the review action state to `PENDING`, which means you will need to re-submit the pull request review using a review action.", - "enum": ["APPROVE", "REQUEST_CHANGES", "COMMENT"], - "name": "event", - "type": "string", - "required": true - }, - { - "alias": "pull_number", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "number", - "type": null, - "required": null - } - ] - }, - { - "name": "Update a pull request branch", - "scope": "pulls", - "id": "updateBranch", - "method": "PUT", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/update-branch", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "pull_number parameter", - "enum": null, - "name": "pull_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a `422 Unprocessable Entity` status. You can use the \"[List commits on a repository](https://developer.github.com/v3/repos/commits/#list-commits-on-a-repository)\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref.", - "enum": null, - "name": "expected_head_sha", - "type": "string", - "required": false - } - ] - }, - { - "name": "Get the README", - "scope": "repos", - "id": "getReadme", - "method": "GET", - "url": "/repos/{owner}/{repo}/readme", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)", - "enum": null, - "name": "ref", - "type": "string", - "required": false - } - ] - }, - { - "name": "List releases for a repository", - "scope": "repos", - "id": "listReleases", - "method": "GET", - "url": "/repos/{owner}/{repo}/releases", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Create a release", - "scope": "repos", - "id": "createRelease", - "method": "POST", - "url": "/repos/{owner}/{repo}/releases", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The name of the tag.", - "enum": null, - "name": "tag_name", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually `master`).", - "enum": null, - "name": "target_commitish", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The name of the release.", - "enum": null, - "name": "name", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Text describing the contents of the tag.", - "enum": null, - "name": "body", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "`true` to create a draft (unpublished) release, `false` to create a published one.", - "enum": null, - "name": "draft", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "`true` to identify the release as a prerelease. `false` to identify the release as a full release.", - "enum": null, - "name": "prerelease", - "type": "boolean", - "required": false - } - ] - }, - { - "name": "Get a single release asset", - "scope": "repos", - "id": "getReleaseAsset", - "method": "GET", - "url": "/repos/{owner}/{repo}/releases/assets/{asset_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "asset_id parameter", - "enum": null, - "name": "asset_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Edit a release asset", - "scope": "repos", - "id": "updateReleaseAsset", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/releases/assets/{asset_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "asset_id parameter", - "enum": null, - "name": "asset_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The file name of the asset.", - "enum": null, - "name": "name", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "An alternate short description of the asset. Used in place of the filename.", - "enum": null, - "name": "label", - "type": "string", - "required": false - } - ] - }, - { - "name": "Delete a release asset", - "scope": "repos", - "id": "deleteReleaseAsset", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/releases/assets/{asset_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "asset_id parameter", - "enum": null, - "name": "asset_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Get the latest release", - "scope": "repos", - "id": "getLatestRelease", - "method": "GET", - "url": "/repos/{owner}/{repo}/releases/latest", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - } - ] - }, - { - "name": "Get a release by tag name", - "scope": "repos", - "id": "getReleaseByTag", - "method": "GET", - "url": "/repos/{owner}/{repo}/releases/tags/{tag}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "tag parameter", - "enum": null, - "name": "tag", - "type": "string", - "required": true - } - ] - }, - { - "name": "Get a single release", - "scope": "repos", - "id": "getRelease", - "method": "GET", - "url": "/repos/{owner}/{repo}/releases/{release_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "release_id parameter", - "enum": null, - "name": "release_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Edit a release", - "scope": "repos", - "id": "updateRelease", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/releases/{release_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "release_id parameter", - "enum": null, - "name": "release_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The name of the tag.", - "enum": null, - "name": "tag_name", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually `master`).", - "enum": null, - "name": "target_commitish", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The name of the release.", - "enum": null, - "name": "name", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Text describing the contents of the tag.", - "enum": null, - "name": "body", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "`true` makes the release a draft, and `false` publishes the release.", - "enum": null, - "name": "draft", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "`true` to identify the release as a prerelease, `false` to identify the release as a full release.", - "enum": null, - "name": "prerelease", - "type": "boolean", - "required": false - } - ] - }, - { - "name": "Delete a release", - "scope": "repos", - "id": "deleteRelease", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/releases/{release_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "release_id parameter", - "enum": null, - "name": "release_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "List assets for a release", - "scope": "repos", - "id": "listAssetsForRelease", - "method": "GET", - "url": "/repos/{owner}/{repo}/releases/{release_id}/assets", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "release_id parameter", - "enum": null, - "name": "release_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "List Stargazers", - "scope": "activity", - "id": "listStargazersForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/stargazers", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Get the number of additions and deletions per week", - "scope": "repos", - "id": "getCodeFrequencyStats", - "method": "GET", - "url": "/repos/{owner}/{repo}/stats/code_frequency", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - } - ] - }, - { - "name": "Get the last year of commit activity data", - "scope": "repos", - "id": "getCommitActivityStats", - "method": "GET", - "url": "/repos/{owner}/{repo}/stats/commit_activity", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - } - ] - }, - { - "name": "Get contributors list with additions, deletions, and commit counts", - "scope": "repos", - "id": "getContributorsStats", - "method": "GET", - "url": "/repos/{owner}/{repo}/stats/contributors", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - } - ] - }, - { - "name": "Get the weekly commit count for the repository owner and everyone else", - "scope": "repos", - "id": "getParticipationStats", - "method": "GET", - "url": "/repos/{owner}/{repo}/stats/participation", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - } - ] - }, - { - "name": "Get the number of commits per hour in each day", - "scope": "repos", - "id": "getPunchCardStats", - "method": "GET", - "url": "/repos/{owner}/{repo}/stats/punch_card", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - } - ] - }, - { - "name": "Create a status", - "scope": "repos", - "id": "createStatus", - "method": "POST", - "url": "/repos/{owner}/{repo}/statuses/{sha}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "sha parameter", - "enum": null, - "name": "sha", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The state of the status. Can be one of `error`, `failure`, `pending`, or `success`.", - "enum": ["error", "failure", "pending", "success"], - "name": "state", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status. \nFor example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA: \n`http://ci.example.com/user/repo/build/sha`", - "enum": null, - "name": "target_url", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A short description of the status.", - "enum": null, - "name": "description", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A string label to differentiate this status from the status of other systems.", - "enum": null, - "name": "context", - "type": "string", - "required": false - } - ] - }, - { - "name": "List watchers", - "scope": "activity", - "id": "listWatchersForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/subscribers", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Get a Repository Subscription", - "scope": "activity", - "id": "getRepoSubscription", - "method": "GET", - "url": "/repos/{owner}/{repo}/subscription", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - } - ] - }, - { - "name": "Set a Repository Subscription", - "scope": "activity", - "id": "setRepoSubscription", - "method": "PUT", - "url": "/repos/{owner}/{repo}/subscription", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Determines if notifications should be received from this repository.", - "enum": null, - "name": "subscribed", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Determines if all notifications should be blocked from this repository.", - "enum": null, - "name": "ignored", - "type": "boolean", - "required": false - } - ] - }, - { - "name": "Delete a Repository Subscription", - "scope": "activity", - "id": "deleteRepoSubscription", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/subscription", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - } - ] - }, - { - "name": "List tags", - "scope": "repos", - "id": "listTags", - "method": "GET", - "url": "/repos/{owner}/{repo}/tags", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "List teams", - "scope": "repos", - "id": "listTeams", - "method": "GET", - "url": "/repos/{owner}/{repo}/teams", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "List all topics for a repository", - "scope": "repos", - "id": "listTopics", - "method": "GET", - "url": "/repos/{owner}/{repo}/topics", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - } - ] - }, - { - "name": "Replace all topics for a repository", - "scope": "repos", - "id": "replaceTopics", - "method": "PUT", - "url": "/repos/{owner}/{repo}/topics", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "An array of topics to add to the repository. Pass one or more topics to _replace_ the set of existing topics. Send an empty array (`[]`) to clear all topics from the repository. **Note:** Topic `names` cannot contain uppercase letters.", - "enum": null, - "name": "names", - "type": "string[]", - "required": true - } - ] - }, - { - "name": "Clones", - "scope": "repos", - "id": "getClones", - "method": "GET", - "url": "/repos/{owner}/{repo}/traffic/clones", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Must be one of: `day`, `week`.", - "enum": ["day", "week"], - "name": "per", - "type": "string", - "required": false - } - ] - }, - { - "name": "List paths", - "scope": "repos", - "id": "getTopPaths", - "method": "GET", - "url": "/repos/{owner}/{repo}/traffic/popular/paths", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - } - ] - }, - { - "name": "List referrers", - "scope": "repos", - "id": "getTopReferrers", - "method": "GET", - "url": "/repos/{owner}/{repo}/traffic/popular/referrers", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - } - ] - }, - { - "name": "Views", - "scope": "repos", - "id": "getViews", - "method": "GET", - "url": "/repos/{owner}/{repo}/traffic/views", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Must be one of: `day`, `week`.", - "enum": ["day", "week"], - "name": "per", - "type": "string", - "required": false - } - ] - }, - { - "name": "Transfer a repository", - "scope": "repos", - "id": "transfer", - "method": "POST", - "url": "/repos/{owner}/{repo}/transfer", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "**Required:** The username or organization name the repository will be transferred to.", - "enum": null, - "name": "new_owner", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.", - "enum": null, - "name": "team_ids", - "type": "integer[]", - "required": false - } - ] - }, - { - "name": "Check if vulnerability alerts are enabled for a repository", - "scope": "repos", - "id": "checkVulnerabilityAlerts", - "method": "GET", - "url": "/repos/{owner}/{repo}/vulnerability-alerts", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - } - ] - }, - { - "name": "Enable vulnerability alerts", - "scope": "repos", - "id": "enableVulnerabilityAlerts", - "method": "PUT", - "url": "/repos/{owner}/{repo}/vulnerability-alerts", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - } - ] - }, - { - "name": "Disable vulnerability alerts", - "scope": "repos", - "id": "disableVulnerabilityAlerts", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/vulnerability-alerts", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - } - ] - }, - { - "name": "Get archive link", - "scope": "repos", - "id": "getArchiveLink", - "method": "GET", - "url": "/repos/{owner}/{repo}/{archive_format}/{ref}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "archive_format parameter", - "enum": null, - "name": "archive_format", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "ref parameter", - "enum": null, - "name": "ref", - "type": "string", - "required": true - } - ] - }, - { - "name": "Create repository using a repository template", - "scope": "repos", - "id": "createUsingTemplate", - "method": "POST", - "url": "/repos/{template_owner}/{template_repo}/generate", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "template_owner parameter", - "enum": null, - "name": "template_owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "template_repo parameter", - "enum": null, - "name": "template_repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The organization or person who will own the new repository. To create a new repository in an organization, the authenticated user must be a member of the specified organization.", - "enum": null, - "name": "owner", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The name of the new repository.", - "enum": null, - "name": "name", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A short description of the new repository.", - "enum": null, - "name": "description", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Either `true` to create a new private repository or `false` to create a new public one.", - "enum": null, - "name": "private", - "type": "boolean", - "required": false - } - ] - }, - { - "name": "List all public repositories", - "scope": "repos", - "id": "listPublic", - "method": "GET", - "url": "/repositories", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The integer ID of the last Repository that you've seen.", - "enum": null, - "name": "since", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Get a list of provisioned identities", - "scope": "scim", - "id": "listProvisionedIdentities", - "method": "GET", - "url": "/scim/v2/organizations/{org}/Users", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Used for pagination: the index of the first result to return.", - "enum": null, - "name": "startIndex", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Used for pagination: the number of results to return.", - "enum": null, - "name": "count", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Filters results using the equals query parameter operator (`eq`). You can filter results that are equal to `id`, `userName`, `emails`, and `external_id`. For example, to search for an identity with the `userName` Octocat, you would use this query: `?filter=userName%20eq%20\\\"Octocat\\\"`.", - "enum": null, - "name": "filter", - "type": "string", - "required": false - } - ] - }, - { - "name": "Provision and invite users", - "scope": "scim", - "id": "provisionAndInviteUsers", - "method": "POST", - "url": "/scim/v2/organizations/{org}/Users", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - } - ] - }, - { - "name": "Provision and invite users", - "scope": "scim", - "id": "provisionInviteUsers", - "method": "POST", - "url": "/scim/v2/organizations/{org}/Users", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - } - ] - }, - { - "name": "Get provisioning details for a single user", - "scope": "scim", - "id": "getProvisioningDetailsForUser", - "method": "GET", - "url": "/scim/v2/organizations/{org}/Users/{scim_user_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "scim_user_id parameter", - "enum": null, - "name": "scim_user_id", - "type": "integer", - "required": true - }, - { - "alias": "scim_user_id", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "external_identity_guid", - "type": null, - "required": null - } - ] - }, - { - "name": "Replace a provisioned user's information", - "scope": "scim", - "id": "replaceProvisionedUserInformation", - "method": "PUT", - "url": "/scim/v2/organizations/{org}/Users/{scim_user_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "scim_user_id parameter", - "enum": null, - "name": "scim_user_id", - "type": "integer", - "required": true - }, - { - "alias": "scim_user_id", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "external_identity_guid", - "type": null, - "required": null - } - ] - }, - { - "name": "Replace a provisioned user's information", - "scope": "scim", - "id": "updateProvisionedOrgMembership", - "method": "PUT", - "url": "/scim/v2/organizations/{org}/Users/{scim_user_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "scim_user_id parameter", - "enum": null, - "name": "scim_user_id", - "type": "integer", - "required": true - }, - { - "alias": "scim_user_id", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "external_identity_guid", - "type": null, - "required": null - } - ] - }, - { - "name": "Update a user attribute", - "scope": "scim", - "id": "updateUserAttribute", - "method": "PATCH", - "url": "/scim/v2/organizations/{org}/Users/{scim_user_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "scim_user_id parameter", - "enum": null, - "name": "scim_user_id", - "type": "integer", - "required": true - }, - { - "alias": "scim_user_id", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "external_identity_guid", - "type": null, - "required": null - } - ] - }, - { - "name": "Remove a user from the organization", - "scope": "scim", - "id": "removeUserFromOrg", - "method": "DELETE", - "url": "/scim/v2/organizations/{org}/Users/{scim_user_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "scim_user_id parameter", - "enum": null, - "name": "scim_user_id", - "type": "integer", - "required": true - }, - { - "alias": "scim_user_id", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "external_identity_guid", - "type": null, - "required": null - } - ] - }, - { - "name": "Search code", - "scope": "search", - "id": "code", - "method": "GET", - "url": "/search/code", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). See \"[Searching code](https://help.github.com/articles/searching-code/)\" for a detailed list of qualifiers.", - "enum": null, - "name": "q", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub search infrastructure. Default: [best match](https://developer.github.com/v3/search/#ranking-search-results)", - "enum": ["indexed"], - "name": "sort", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", - "enum": ["desc", "asc"], - "name": "order", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Search commits", - "scope": "search", - "id": "commits", - "method": "GET", - "url": "/search/commits", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). See \"[Searching commits](https://help.github.com/articles/searching-commits/)\" for a detailed list of qualifiers.", - "enum": null, - "name": "q", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Sorts the results of your query by `author-date` or `committer-date`. Default: [best match](https://developer.github.com/v3/search/#ranking-search-results)", - "enum": ["author-date", "committer-date"], - "name": "sort", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", - "enum": ["desc", "asc"], - "name": "order", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Search issues and pull requests", - "scope": "search", - "id": "issuesAndPullRequests", - "method": "GET", - "url": "/search/issues", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). See \"[Searching issues and pull requests](https://help.github.com/articles/searching-issues-and-pull-requests/)\" for a detailed list of qualifiers.", - "enum": null, - "name": "q", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Sorts the results of your query by the number of `comments`, `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: [best match](https://developer.github.com/v3/search/#ranking-search-results)", - "enum": [ - "comments", - "reactions", - "reactions-+1", - "reactions--1", - "reactions-smile", - "reactions-thinking_face", - "reactions-heart", - "reactions-tada", - "interactions", - "created", - "updated" - ], - "name": "sort", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", - "enum": ["desc", "asc"], - "name": "order", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Search issues and pull requests", - "scope": "search", - "id": "issues", - "method": "GET", - "url": "/search/issues", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). See \"[Searching issues and pull requests](https://help.github.com/articles/searching-issues-and-pull-requests/)\" for a detailed list of qualifiers.", - "enum": null, - "name": "q", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Sorts the results of your query by the number of `comments`, `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: [best match](https://developer.github.com/v3/search/#ranking-search-results)", - "enum": [ - "comments", - "reactions", - "reactions-+1", - "reactions--1", - "reactions-smile", - "reactions-thinking_face", - "reactions-heart", - "reactions-tada", - "interactions", - "created", - "updated" - ], - "name": "sort", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", - "enum": ["desc", "asc"], - "name": "order", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Search labels", - "scope": "search", - "id": "labels", - "method": "GET", - "url": "/search/labels", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The id of the repository.", - "enum": null, - "name": "repository_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query).", - "enum": null, - "name": "q", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://developer.github.com/v3/search/#ranking-search-results)", - "enum": ["created", "updated"], - "name": "sort", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", - "enum": ["desc", "asc"], - "name": "order", - "type": "string", - "required": false - } - ] - }, - { - "name": "Search repositories", - "scope": "search", - "id": "repos", - "method": "GET", - "url": "/search/repositories", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). See \"[Searching for repositories](https://help.github.com/articles/searching-for-repositories/)\" for a detailed list of qualifiers.", - "enum": null, - "name": "q", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Sorts the results of your query by number of `stars`, `forks`, or `help-wanted-issues` or how recently the items were `updated`. Default: [best match](https://developer.github.com/v3/search/#ranking-search-results)", - "enum": ["stars", "forks", "help-wanted-issues", "updated"], - "name": "sort", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", - "enum": ["desc", "asc"], - "name": "order", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Search topics", - "scope": "search", - "id": "topics", - "method": "GET", - "url": "/search/topics", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query).", - "enum": null, - "name": "q", - "type": "string", - "required": true - } - ] - }, - { - "name": "Search users", - "scope": "search", - "id": "users", - "method": "GET", - "url": "/search/users", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). See \"[Searching users](https://help.github.com/articles/searching-users/)\" for a detailed list of qualifiers.", - "enum": null, - "name": "q", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub. Default: [best match](https://developer.github.com/v3/search/#ranking-search-results)", - "enum": ["followers", "repositories", "joined"], - "name": "sort", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", - "enum": ["desc", "asc"], - "name": "order", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Get team", - "scope": "teams", - "id": "get", - "method": "GET", - "url": "/teams/{team_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "team_id parameter", - "enum": null, - "name": "team_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Edit team", - "scope": "teams", - "id": "update", - "method": "PATCH", - "url": "/teams/{team_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "team_id parameter", - "enum": null, - "name": "team_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The name of the team.", - "enum": null, - "name": "name", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The description of the team.", - "enum": null, - "name": "description", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. The options are: \n**For a non-nested team:** \n\\* `secret` - only visible to organization owners and members of this team. \n\\* `closed` - visible to all members of this organization. \n**For a parent or child team:** \n\\* `closed` - visible to all members of this organization.", - "enum": ["secret", "closed"], - "name": "privacy", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified. Can be one of: \n\\* `pull` - team members can pull, but not push to or administer newly-added repositories. \n\\* `push` - team members can pull and push, but not administer newly-added repositories. \n\\* `admin` - team members can pull, push and administer newly-added repositories.", - "enum": ["pull", "push", "admin"], - "name": "permission", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The ID of a team to set as the parent team. **Note**: You must pass the `hellcat-preview` media type to use this parameter.", - "enum": null, - "name": "parent_team_id", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Delete team", - "scope": "teams", - "id": "delete", - "method": "DELETE", - "url": "/teams/{team_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "team_id parameter", - "enum": null, - "name": "team_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "List discussions", - "scope": "teams", - "id": "listDiscussions", - "method": "GET", - "url": "/teams/{team_id}/discussions", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "team_id parameter", - "enum": null, - "name": "team_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Sorts the discussion comments by the date they were created. To return the oldest comments first, set to `asc`. Can be one of `asc` or `desc`.", - "enum": ["asc", "desc"], - "name": "direction", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Create a discussion", - "scope": "teams", - "id": "createDiscussion", - "method": "POST", - "url": "/teams/{team_id}/discussions", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "team_id parameter", - "enum": null, - "name": "team_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The discussion post's title.", - "enum": null, - "name": "title", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The discussion post's body text.", - "enum": null, - "name": "body", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post.", - "enum": null, - "name": "private", - "type": "boolean", - "required": false - } - ] - }, - { - "name": "Get a single discussion", - "scope": "teams", - "id": "getDiscussion", - "method": "GET", - "url": "/teams/{team_id}/discussions/{discussion_number}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "team_id parameter", - "enum": null, - "name": "team_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "discussion_number parameter", - "enum": null, - "name": "discussion_number", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Edit a discussion", - "scope": "teams", - "id": "updateDiscussion", - "method": "PATCH", - "url": "/teams/{team_id}/discussions/{discussion_number}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "team_id parameter", - "enum": null, - "name": "team_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "discussion_number parameter", - "enum": null, - "name": "discussion_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The discussion post's title.", - "enum": null, - "name": "title", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The discussion post's body text.", - "enum": null, - "name": "body", - "type": "string", - "required": false - } - ] - }, - { - "name": "Delete a discussion", - "scope": "teams", - "id": "deleteDiscussion", - "method": "DELETE", - "url": "/teams/{team_id}/discussions/{discussion_number}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "team_id parameter", - "enum": null, - "name": "team_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "discussion_number parameter", - "enum": null, - "name": "discussion_number", - "type": "integer", - "required": true - } - ] - }, - { - "name": "List comments", - "scope": "teams", - "id": "listDiscussionComments", - "method": "GET", - "url": "/teams/{team_id}/discussions/{discussion_number}/comments", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "team_id parameter", - "enum": null, - "name": "team_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "discussion_number parameter", - "enum": null, - "name": "discussion_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Sorts the discussion comments by the date they were created. To return the oldest comments first, set to `asc`. Can be one of `asc` or `desc`.", - "enum": ["asc", "desc"], - "name": "direction", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Create a comment", - "scope": "teams", - "id": "createDiscussionComment", - "method": "POST", - "url": "/teams/{team_id}/discussions/{discussion_number}/comments", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "team_id parameter", - "enum": null, - "name": "team_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "discussion_number parameter", - "enum": null, - "name": "discussion_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The discussion comment's body text.", - "enum": null, - "name": "body", - "type": "string", - "required": true - } - ] - }, - { - "name": "Get a single comment", - "scope": "teams", - "id": "getDiscussionComment", - "method": "GET", - "url": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "team_id parameter", - "enum": null, - "name": "team_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "discussion_number parameter", - "enum": null, - "name": "discussion_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "comment_number parameter", - "enum": null, - "name": "comment_number", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Edit a comment", - "scope": "teams", - "id": "updateDiscussionComment", - "method": "PATCH", - "url": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "team_id parameter", - "enum": null, - "name": "team_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "discussion_number parameter", - "enum": null, - "name": "discussion_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "comment_number parameter", - "enum": null, - "name": "comment_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The discussion comment's body text.", - "enum": null, - "name": "body", - "type": "string", - "required": true - } - ] - }, - { - "name": "Delete a comment", - "scope": "teams", - "id": "deleteDiscussionComment", - "method": "DELETE", - "url": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "team_id parameter", - "enum": null, - "name": "team_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "discussion_number parameter", - "enum": null, - "name": "discussion_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "comment_number parameter", - "enum": null, - "name": "comment_number", - "type": "integer", - "required": true - } - ] - }, - { - "name": "List reactions for a team discussion comment", - "scope": "reactions", - "id": "listForTeamDiscussionComment", - "method": "GET", - "url": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "team_id parameter", - "enum": null, - "name": "team_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "discussion_number parameter", - "enum": null, - "name": "discussion_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "comment_number parameter", - "enum": null, - "name": "comment_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a team discussion comment.", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "name": "content", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Create reaction for a team discussion comment", - "scope": "reactions", - "id": "createForTeamDiscussionComment", - "method": "POST", - "url": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "team_id parameter", - "enum": null, - "name": "team_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "discussion_number parameter", - "enum": null, - "name": "discussion_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "comment_number parameter", - "enum": null, - "name": "comment_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the team discussion comment.", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "name": "content", - "type": "string", - "required": true - } - ] - }, - { - "name": "List reactions for a team discussion", - "scope": "reactions", - "id": "listForTeamDiscussion", - "method": "GET", - "url": "/teams/{team_id}/discussions/{discussion_number}/reactions", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "team_id parameter", - "enum": null, - "name": "team_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "discussion_number parameter", - "enum": null, - "name": "discussion_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a team discussion.", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "name": "content", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Create reaction for a team discussion", - "scope": "reactions", - "id": "createForTeamDiscussion", - "method": "POST", - "url": "/teams/{team_id}/discussions/{discussion_number}/reactions", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "team_id parameter", - "enum": null, - "name": "team_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "discussion_number parameter", - "enum": null, - "name": "discussion_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the team discussion.", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "name": "content", - "type": "string", - "required": true - } - ] - }, - { - "name": "List pending team invitations", - "scope": "teams", - "id": "listPendingInvitations", - "method": "GET", - "url": "/teams/{team_id}/invitations", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "team_id parameter", - "enum": null, - "name": "team_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "List team members", - "scope": "teams", - "id": "listMembers", - "method": "GET", - "url": "/teams/{team_id}/members", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "team_id parameter", - "enum": null, - "name": "team_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Filters members returned by their role in the team. Can be one of: \n\\* `member` - normal members of the team. \n\\* `maintainer` - team maintainers. \n\\* `all` - all members of the team.", - "enum": ["member", "maintainer", "all"], - "name": "role", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Get team member", - "scope": "teams", - "id": "getMember", - "method": "GET", - "url": "/teams/{team_id}/members/{username}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "team_id parameter", - "enum": null, - "name": "team_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - } - ] - }, - { - "name": "Add team member", - "scope": "teams", - "id": "addMember", - "method": "PUT", - "url": "/teams/{team_id}/members/{username}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "team_id parameter", - "enum": null, - "name": "team_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - } - ] - }, - { - "name": "Remove team member", - "scope": "teams", - "id": "removeMember", - "method": "DELETE", - "url": "/teams/{team_id}/members/{username}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "team_id parameter", - "enum": null, - "name": "team_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - } - ] - }, - { - "name": "Get team membership", - "scope": "teams", - "id": "getMembership", - "method": "GET", - "url": "/teams/{team_id}/memberships/{username}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "team_id parameter", - "enum": null, - "name": "team_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - } - ] - }, - { - "name": "Add or update team membership", - "scope": "teams", - "id": "addOrUpdateMembership", - "method": "PUT", - "url": "/teams/{team_id}/memberships/{username}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "team_id parameter", - "enum": null, - "name": "team_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The role that this user should have in the team. Can be one of: \n\\* `member` - a normal member of the team. \n\\* `maintainer` - a team maintainer. Able to add/remove other team members, promote other team members to team maintainer, and edit the team's name and description.", - "enum": ["member", "maintainer"], - "name": "role", - "type": "string", - "required": false - } - ] - }, - { - "name": "Remove team membership", - "scope": "teams", - "id": "removeMembership", - "method": "DELETE", - "url": "/teams/{team_id}/memberships/{username}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "team_id parameter", - "enum": null, - "name": "team_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - } - ] - }, - { - "name": "List team projects", - "scope": "teams", - "id": "listProjects", - "method": "GET", - "url": "/teams/{team_id}/projects", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "team_id parameter", - "enum": null, - "name": "team_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Review a team project", - "scope": "teams", - "id": "reviewProject", - "method": "GET", - "url": "/teams/{team_id}/projects/{project_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "team_id parameter", - "enum": null, - "name": "team_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "project_id parameter", - "enum": null, - "name": "project_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Add or update team project", - "scope": "teams", - "id": "addOrUpdateProject", - "method": "PUT", - "url": "/teams/{team_id}/projects/{project_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "team_id parameter", - "enum": null, - "name": "team_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "project_id parameter", - "enum": null, - "name": "project_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The permission to grant to the team for this project. Can be one of: \n\\* `read` - team members can read, but not write to or administer this project. \n\\* `write` - team members can read and write, but not administer this project. \n\\* `admin` - team members can read, write and administer this project. \nDefault: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://developer.github.com/v3/#http-verbs).\" \n**Note**: If you pass the `hellcat-preview` media type, you can promote—but not demote—a `permission` attribute inherited from a parent team.", - "enum": ["read", "write", "admin"], - "name": "permission", - "type": "string", - "required": false - } - ] - }, - { - "name": "Remove team project", - "scope": "teams", - "id": "removeProject", - "method": "DELETE", - "url": "/teams/{team_id}/projects/{project_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "team_id parameter", - "enum": null, - "name": "team_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "project_id parameter", - "enum": null, - "name": "project_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "List team repos", - "scope": "teams", - "id": "listRepos", - "method": "GET", - "url": "/teams/{team_id}/repos", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "team_id parameter", - "enum": null, - "name": "team_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Check if a team manages a repository", - "scope": "teams", - "id": "checkManagesRepo", - "method": "GET", - "url": "/teams/{team_id}/repos/{owner}/{repo}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "team_id parameter", - "enum": null, - "name": "team_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - } - ] - }, - { - "name": "Add or update team repository", - "scope": "teams", - "id": "addOrUpdateRepo", - "method": "PUT", - "url": "/teams/{team_id}/repos/{owner}/{repo}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "team_id parameter", - "enum": null, - "name": "team_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The permission to grant the team on this repository. Can be one of: \n\\* `pull` - team members can pull, but not push to or administer this repository. \n\\* `push` - team members can pull and push, but not administer this repository. \n\\* `admin` - team members can pull, push and administer this repository. \n \nIf no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository. \n**Note**: If you pass the `hellcat-preview` media type, you can promote—but not demote—a `permission` attribute inherited through a parent team.", - "enum": ["pull", "push", "admin"], - "name": "permission", - "type": "string", - "required": false - } - ] - }, - { - "name": "Remove team repository", - "scope": "teams", - "id": "removeRepo", - "method": "DELETE", - "url": "/teams/{team_id}/repos/{owner}/{repo}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "team_id parameter", - "enum": null, - "name": "team_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - } - ] - }, - { - "name": "List IdP groups for a team", - "scope": "teams", - "id": "listIdPGroups", - "method": "GET", - "url": "/teams/{team_id}/team-sync/group-mappings", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "team_id parameter", - "enum": null, - "name": "team_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Create or update IdP group connections", - "scope": "teams", - "id": "createOrUpdateIdPGroupConnections", - "method": "PATCH", - "url": "/teams/{team_id}/team-sync/group-mappings", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "team_id parameter", - "enum": null, - "name": "team_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The IdP groups you want to connect to a GitHub team. When updating, the new `groups` object will replace the original one. You must include any existing groups that you don't want to remove.", - "enum": null, - "name": "groups", - "type": "object[]", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "ID of the IdP group.", - "enum": null, - "name": "groups[].group_id", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Name of the IdP group.", - "enum": null, - "name": "groups[].group_name", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Description of the IdP group.", - "enum": null, - "name": "groups[].group_description", - "type": "string", - "required": true - } - ] - }, - { - "name": "List child teams", - "scope": "teams", - "id": "listChild", - "method": "GET", - "url": "/teams/{team_id}/teams", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "team_id parameter", - "enum": null, - "name": "team_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Get the authenticated user", - "scope": "users", - "id": "getAuthenticated", - "method": "GET", - "url": "/user", - "parameters": [] - }, - { - "name": "Update the authenticated user", - "scope": "users", - "id": "updateAuthenticated", - "method": "PATCH", - "url": "/user", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The new name of the user.", - "enum": null, - "name": "name", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The publicly visible email address of the user.", - "enum": null, - "name": "email", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The new blog URL of the user.", - "enum": null, - "name": "blog", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The new company of the user.", - "enum": null, - "name": "company", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The new location of the user.", - "enum": null, - "name": "location", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The new hiring availability of the user.", - "enum": null, - "name": "hireable", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The new short biography of the user.", - "enum": null, - "name": "bio", - "type": "string", - "required": false - } - ] - }, - { - "name": "List blocked users", - "scope": "users", - "id": "listBlocked", - "method": "GET", - "url": "/user/blocks", - "parameters": [] - }, - { - "name": "Check whether you've blocked a user", - "scope": "users", - "id": "checkBlocked", - "method": "GET", - "url": "/user/blocks/{username}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - } - ] - }, - { - "name": "Block a user", - "scope": "users", - "id": "block", - "method": "PUT", - "url": "/user/blocks/{username}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - } - ] - }, - { - "name": "Unblock a user", - "scope": "users", - "id": "unblock", - "method": "DELETE", - "url": "/user/blocks/{username}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - } - ] - }, - { - "name": "Toggle primary email visibility", - "scope": "users", - "id": "togglePrimaryEmailVisibility", - "method": "PATCH", - "url": "/user/email/visibility", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Specify the _primary_ email address that needs a visibility change.", - "enum": null, - "name": "email", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Use `public` to enable an authenticated user to view the specified email address, or use `private` so this primary email address cannot be seen publicly.", - "enum": null, - "name": "visibility", - "type": "string", - "required": true - } - ] - }, - { - "name": "List email addresses for a user", - "scope": "users", - "id": "listEmails", - "method": "GET", - "url": "/user/emails", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Add email address(es)", - "scope": "users", - "id": "addEmails", - "method": "POST", - "url": "/user/emails", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", - "enum": null, - "name": "emails", - "type": "string[]", - "required": true - } - ] - }, - { - "name": "Delete email address(es)", - "scope": "users", - "id": "deleteEmails", - "method": "DELETE", - "url": "/user/emails", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Deletes one or more email addresses from your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", - "enum": null, - "name": "emails", - "type": "string[]", - "required": true - } - ] - }, - { - "name": "List the authenticated user's followers", - "scope": "users", - "id": "listFollowersForAuthenticatedUser", - "method": "GET", - "url": "/user/followers", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "List who the authenticated user is following", - "scope": "users", - "id": "listFollowingForAuthenticatedUser", - "method": "GET", - "url": "/user/following", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Check if you are following a user", - "scope": "users", - "id": "checkFollowing", - "method": "GET", - "url": "/user/following/{username}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - } - ] - }, - { - "name": "Follow a user", - "scope": "users", - "id": "follow", - "method": "PUT", - "url": "/user/following/{username}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - } - ] - }, - { - "name": "Unfollow a user", - "scope": "users", - "id": "unfollow", - "method": "DELETE", - "url": "/user/following/{username}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - } - ] - }, - { - "name": "List your GPG keys", - "scope": "users", - "id": "listGpgKeys", - "method": "GET", - "url": "/user/gpg_keys", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Create a GPG key", - "scope": "users", - "id": "createGpgKey", - "method": "POST", - "url": "/user/gpg_keys", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Your GPG key, generated in ASCII-armored format. See \"[Generating a new GPG key](https://help.github.com/articles/generating-a-new-gpg-key/)\" for help creating a GPG key.", - "enum": null, - "name": "armored_public_key", - "type": "string", - "required": false - } - ] - }, - { - "name": "Get a single GPG key", - "scope": "users", - "id": "getGpgKey", - "method": "GET", - "url": "/user/gpg_keys/{gpg_key_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "gpg_key_id parameter", - "enum": null, - "name": "gpg_key_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Delete a GPG key", - "scope": "users", - "id": "deleteGpgKey", - "method": "DELETE", - "url": "/user/gpg_keys/{gpg_key_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "gpg_key_id parameter", - "enum": null, - "name": "gpg_key_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "List installations for a user", - "scope": "apps", - "id": "listInstallationsForAuthenticatedUser", - "method": "GET", - "url": "/user/installations", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "List repositories accessible to the user for an installation", - "scope": "apps", - "id": "listInstallationReposForAuthenticatedUser", - "method": "GET", - "url": "/user/installations/{installation_id}/repositories", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "installation_id parameter", - "enum": null, - "name": "installation_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Add repository to installation", - "scope": "apps", - "id": "addRepoToInstallation", - "method": "PUT", - "url": "/user/installations/{installation_id}/repositories/{repository_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "installation_id parameter", - "enum": null, - "name": "installation_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repository_id parameter", - "enum": null, - "name": "repository_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Remove repository from installation", - "scope": "apps", - "id": "removeRepoFromInstallation", - "method": "DELETE", - "url": "/user/installations/{installation_id}/repositories/{repository_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "installation_id parameter", - "enum": null, - "name": "installation_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repository_id parameter", - "enum": null, - "name": "repository_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "List all issues across owned and member repositories assigned to the authenticated user", - "scope": "issues", - "id": "listForAuthenticatedUser", - "method": "GET", - "url": "/user/issues", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Indicates which sorts of issues to return. Can be one of: \n\\* `assigned`: Issues assigned to you \n\\* `created`: Issues created by you \n\\* `mentioned`: Issues mentioning you \n\\* `subscribed`: Issues you're subscribed to updates for \n\\* `all`: All issues the authenticated user can see, regardless of participation or creation", - "enum": ["assigned", "created", "mentioned", "subscribed", "all"], - "name": "filter", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.", - "enum": ["open", "closed", "all"], - "name": "state", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A list of comma separated label names. Example: `bug,ui,@high`", - "enum": null, - "name": "labels", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "What to sort results by. Can be either `created`, `updated`, `comments`.", - "enum": ["created", "updated", "comments"], - "name": "sort", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The direction of the sort. Can be either `asc` or `desc`.", - "enum": ["asc", "desc"], - "name": "direction", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Only issues updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "enum": null, - "name": "since", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "List your public keys", - "scope": "users", - "id": "listPublicKeys", - "method": "GET", - "url": "/user/keys", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Create a public key", - "scope": "users", - "id": "createPublicKey", - "method": "POST", - "url": "/user/keys", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A descriptive name for the new key. Use a name that will help you recognize this key in your GitHub account. For example, if you're using a personal Mac, you might call this key \"Personal MacBook Air\".", - "enum": null, - "name": "title", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The public SSH key to add to your GitHub account. See \"[Generating a new SSH key](https://help.github.com/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent/)\" for guidance on how to create a public SSH key.", - "enum": null, - "name": "key", - "type": "string", - "required": false - } - ] - }, - { - "name": "Get a single public key", - "scope": "users", - "id": "getPublicKey", - "method": "GET", - "url": "/user/keys/{key_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "key_id parameter", - "enum": null, - "name": "key_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Delete a public key", - "scope": "users", - "id": "deletePublicKey", - "method": "DELETE", - "url": "/user/keys/{key_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "key_id parameter", - "enum": null, - "name": "key_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Get a user's Marketplace purchases", - "scope": "apps", - "id": "listMarketplacePurchasesForAuthenticatedUser", - "method": "GET", - "url": "/user/marketplace_purchases", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Get a user's Marketplace purchases (stubbed)", - "scope": "apps", - "id": "listMarketplacePurchasesForAuthenticatedUserStubbed", - "method": "GET", - "url": "/user/marketplace_purchases/stubbed", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "List your organization memberships", - "scope": "orgs", - "id": "listMemberships", - "method": "GET", - "url": "/user/memberships/orgs", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Indicates the state of the memberships to return. Can be either `active` or `pending`. If not specified, the API returns both active and pending memberships.", - "enum": ["active", "pending"], - "name": "state", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Get your organization membership", - "scope": "orgs", - "id": "getMembershipForAuthenticatedUser", - "method": "GET", - "url": "/user/memberships/orgs/{org}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - } - ] - }, - { - "name": "Edit your organization membership", - "scope": "orgs", - "id": "updateMembership", - "method": "PATCH", - "url": "/user/memberships/orgs/{org}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The state that the membership should be in. Only `\"active\"` will be accepted.", - "enum": ["active"], - "name": "state", - "type": "string", - "required": true - } - ] - }, - { - "name": "Start a user migration", - "scope": "migrations", - "id": "startForAuthenticatedUser", - "method": "POST", - "url": "/user/migrations", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "An array of repositories to include in the migration.", - "enum": null, - "name": "repositories", - "type": "string[]", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Locks the `repositories` to prevent changes during the migration when set to `true`.", - "enum": null, - "name": "lock_repositories", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Does not include attachments uploaded to GitHub.com in the migration data when set to `true`. Excluding attachments will reduce the migration archive file size.", - "enum": null, - "name": "exclude_attachments", - "type": "boolean", - "required": false - } - ] - }, - { - "name": "Get a list of user migrations", - "scope": "migrations", - "id": "listForAuthenticatedUser", - "method": "GET", - "url": "/user/migrations", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Get the status of a user migration", - "scope": "migrations", - "id": "getStatusForAuthenticatedUser", - "method": "GET", - "url": "/user/migrations/{migration_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "migration_id parameter", - "enum": null, - "name": "migration_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Download a user migration archive", - "scope": "migrations", - "id": "getArchiveForAuthenticatedUser", - "method": "GET", - "url": "/user/migrations/{migration_id}/archive", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "migration_id parameter", - "enum": null, - "name": "migration_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Delete a user migration archive", - "scope": "migrations", - "id": "deleteArchiveForAuthenticatedUser", - "method": "DELETE", - "url": "/user/migrations/{migration_id}/archive", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "migration_id parameter", - "enum": null, - "name": "migration_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Unlock a user repository", - "scope": "migrations", - "id": "unlockRepoForAuthenticatedUser", - "method": "DELETE", - "url": "/user/migrations/{migration_id}/repos/{repo_name}/lock", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "migration_id parameter", - "enum": null, - "name": "migration_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo_name parameter", - "enum": null, - "name": "repo_name", - "type": "string", - "required": true - } - ] - }, - { - "name": "List your organizations", - "scope": "orgs", - "id": "listForAuthenticatedUser", - "method": "GET", - "url": "/user/orgs", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Create a user project", - "scope": "projects", - "id": "createForAuthenticatedUser", - "method": "POST", - "url": "/user/projects", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The name of the project.", - "enum": null, - "name": "name", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The description of the project.", - "enum": null, - "name": "body", - "type": "string", - "required": false - } - ] - }, - { - "name": "List public email addresses for a user", - "scope": "users", - "id": "listPublicEmails", - "method": "GET", - "url": "/user/public_emails", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "List your repositories", - "scope": "repos", - "id": "list", - "method": "GET", - "url": "/user/repos", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Can be one of `all`, `public`, or `private`.", - "enum": ["all", "public", "private"], - "name": "visibility", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Comma-separated list of values. Can include: \n\\* `owner`: Repositories that are owned by the authenticated user. \n\\* `collaborator`: Repositories that the user has been added to as a collaborator. \n\\* `organization_member`: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on.", - "enum": null, - "name": "affiliation", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Can be one of `all`, `owner`, `public`, `private`, `member`. Default: `all` \n \nWill cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.", - "enum": ["all", "owner", "public", "private", "member"], - "name": "type", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Can be one of `created`, `updated`, `pushed`, `full_name`.", - "enum": ["created", "updated", "pushed", "full_name"], - "name": "sort", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Can be one of `asc` or `desc`. Default: `asc` when using `full_name`, otherwise `desc`", - "enum": ["asc", "desc"], - "name": "direction", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Creates a new repository for the authenticated user", - "scope": "repos", - "id": "createForAuthenticatedUser", - "method": "POST", - "url": "/user/repos", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The name of the repository.", - "enum": null, - "name": "name", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A short description of the repository.", - "enum": null, - "name": "description", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A URL with more information about the repository.", - "enum": null, - "name": "homepage", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Either `true` to create a private repository or `false` to create a public one. Creating private repositories requires a paid GitHub account.", - "enum": null, - "name": "private", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Either `true` to enable issues for this repository or `false` to disable them.", - "enum": null, - "name": "has_issues", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error.", - "enum": null, - "name": "has_projects", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Either `true` to enable the wiki for this repository or `false` to disable it.", - "enum": null, - "name": "has_wiki", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Either `true` to make this repo available as a template repository or `false` to prevent it.", - "enum": null, - "name": "is_template", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.", - "enum": null, - "name": "team_id", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Pass `true` to create an initial commit with empty README.", - "enum": null, - "name": "auto_init", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Desired language or platform [.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, \"Haskell\".", - "enum": null, - "name": "gitignore_template", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://help.github.com/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, \"mit\" or \"mpl-2.0\".", - "enum": null, - "name": "license_template", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", - "enum": null, - "name": "allow_squash_merge", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.", - "enum": null, - "name": "allow_merge_commit", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", - "enum": null, - "name": "allow_rebase_merge", - "type": "boolean", - "required": false - } - ] - }, - { - "name": "List a user's repository invitations", - "scope": "repos", - "id": "listInvitationsForAuthenticatedUser", - "method": "GET", - "url": "/user/repository_invitations", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Accept a repository invitation", - "scope": "repos", - "id": "acceptInvitation", - "method": "PATCH", - "url": "/user/repository_invitations/{invitation_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "invitation_id parameter", - "enum": null, - "name": "invitation_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Decline a repository invitation", - "scope": "repos", - "id": "declineInvitation", - "method": "DELETE", - "url": "/user/repository_invitations/{invitation_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "invitation_id parameter", - "enum": null, - "name": "invitation_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "List repositories being starred by the authenticated user", - "scope": "activity", - "id": "listReposStarredByAuthenticatedUser", - "method": "GET", - "url": "/user/starred", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to).", - "enum": ["created", "updated"], - "name": "sort", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "One of `asc` (ascending) or `desc` (descending).", - "enum": ["asc", "desc"], - "name": "direction", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Check if you are starring a repository", - "scope": "activity", - "id": "checkStarringRepo", - "method": "GET", - "url": "/user/starred/{owner}/{repo}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - } - ] - }, - { - "name": "Star a repository", - "scope": "activity", - "id": "starRepo", - "method": "PUT", - "url": "/user/starred/{owner}/{repo}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - } - ] - }, - { - "name": "Unstar a repository", - "scope": "activity", - "id": "unstarRepo", - "method": "DELETE", - "url": "/user/starred/{owner}/{repo}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - } - ] - }, - { - "name": "List repositories being watched by the authenticated user", - "scope": "activity", - "id": "listWatchedReposForAuthenticatedUser", - "method": "GET", - "url": "/user/subscriptions", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Check if you are watching a repository (LEGACY)", - "scope": "activity", - "id": "checkWatchingRepoLegacy", - "method": "GET", - "url": "/user/subscriptions/{owner}/{repo}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - } - ] - }, - { - "name": "Watch a repository (LEGACY)", - "scope": "activity", - "id": "watchRepoLegacy", - "method": "PUT", - "url": "/user/subscriptions/{owner}/{repo}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - } - ] - }, - { - "name": "Stop watching a repository (LEGACY)", - "scope": "activity", - "id": "stopWatchingRepoLegacy", - "method": "DELETE", - "url": "/user/subscriptions/{owner}/{repo}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - } - ] - }, - { - "name": "List user teams", - "scope": "teams", - "id": "listForAuthenticatedUser", - "method": "GET", - "url": "/user/teams", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Get all users", - "scope": "users", - "id": "list", - "method": "GET", - "url": "/users", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The integer ID of the last User that you've seen.", - "enum": null, - "name": "since", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Get a single user", - "scope": "users", - "id": "getByUsername", - "method": "GET", - "url": "/users/{username}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - } - ] - }, - { - "name": "List events performed by a user", - "scope": "activity", - "id": "listEventsForUser", - "method": "GET", - "url": "/users/{username}/events", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "List events for an organization", - "scope": "activity", - "id": "listEventsForOrg", - "method": "GET", - "url": "/users/{username}/events/orgs/{org}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "List public events performed by a user", - "scope": "activity", - "id": "listPublicEventsForUser", - "method": "GET", - "url": "/users/{username}/events/public", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "List a user's followers", - "scope": "users", - "id": "listFollowersForUser", - "method": "GET", - "url": "/users/{username}/followers", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "List who a user is following", - "scope": "users", - "id": "listFollowingForUser", - "method": "GET", - "url": "/users/{username}/following", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Check if one user follows another", - "scope": "users", - "id": "checkFollowingForUser", - "method": "GET", - "url": "/users/{username}/following/{target_user}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "target_user parameter", - "enum": null, - "name": "target_user", - "type": "string", - "required": true - } - ] - }, - { - "name": "List public gists for the specified user", - "scope": "gists", - "id": "listPublicForUser", - "method": "GET", - "url": "/users/{username}/gists", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only gists updated at or after this time are returned.", - "enum": null, - "name": "since", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "List GPG keys for a user", - "scope": "users", - "id": "listGpgKeysForUser", - "method": "GET", - "url": "/users/{username}/gpg_keys", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Get contextual information about a user", - "scope": "users", - "id": "getContextForUser", - "method": "GET", - "url": "/users/{username}/hovercard", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Identifies which additional information you'd like to receive about the person's hovercard. Can be `organization`, `repository`, `issue`, `pull_request`. **Required** when using `subject_id`.", - "enum": ["organization", "repository", "issue", "pull_request"], - "name": "subject_type", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Uses the ID for the `subject_type` you specified. **Required** when using `subject_type`.", - "enum": null, - "name": "subject_id", - "type": "string", - "required": false - } - ] - }, - { - "name": "Get a user installation", - "scope": "apps", - "id": "getUserInstallation", - "method": "GET", - "url": "/users/{username}/installation", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - } - ] - }, - { - "name": "Get a user installation", - "scope": "apps", - "id": "findUserInstallation", - "method": "GET", - "url": "/users/{username}/installation", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - } - ] - }, - { - "name": "List public keys for a user", - "scope": "users", - "id": "listPublicKeysForUser", - "method": "GET", - "url": "/users/{username}/keys", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "List user organizations", - "scope": "orgs", - "id": "listForUser", - "method": "GET", - "url": "/users/{username}/orgs", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "List user projects", - "scope": "projects", - "id": "listForUser", - "method": "GET", - "url": "/users/{username}/projects", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`.", - "enum": ["open", "closed", "all"], - "name": "state", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "List events that a user has received", - "scope": "activity", - "id": "listReceivedEventsForUser", - "method": "GET", - "url": "/users/{username}/received_events", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "List public events that a user has received", - "scope": "activity", - "id": "listReceivedPublicEventsForUser", - "method": "GET", - "url": "/users/{username}/received_events/public", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "List user repositories", - "scope": "repos", - "id": "listForUser", - "method": "GET", - "url": "/users/{username}/repos", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Can be one of `all`, `owner`, `member`.", - "enum": ["all", "owner", "member"], - "name": "type", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Can be one of `created`, `updated`, `pushed`, `full_name`.", - "enum": ["created", "updated", "pushed", "full_name"], - "name": "sort", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Can be one of `asc` or `desc`. Default: `asc` when using `full_name`, otherwise `desc`", - "enum": ["asc", "desc"], - "name": "direction", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "List repositories being starred by a user", - "scope": "activity", - "id": "listReposStarredByUser", - "method": "GET", - "url": "/users/{username}/starred", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to).", - "enum": ["created", "updated"], - "name": "sort", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "One of `asc` (ascending) or `desc` (descending).", - "enum": ["asc", "desc"], - "name": "direction", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "List repositories being watched by a user", - "scope": "activity", - "id": "listReposWatchedByUser", - "method": "GET", - "url": "/users/{username}/subscriptions", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - } -] diff --git a/node_modules/@octokit/types/scripts/update-endpoints/templates/endpoints.ts.template b/node_modules/@octokit/types/scripts/update-endpoints/templates/endpoints.ts.template deleted file mode 100644 index 2eceb2f..0000000 --- a/node_modules/@octokit/types/scripts/update-endpoints/templates/endpoints.ts.template +++ /dev/null @@ -1,33 +0,0 @@ -// DO NOT EDIT THIS FILE -import { RequestHeaders } from "../RequestHeaders"; -import { RequestRequestOptions } from "../RequestRequestOptions"; -import { Url } from "../Url"; - -export interface Endpoints { - {{#each endpointsByRoute}} - "{{@key}}": [{{union this "optionsTypeName"}}, {{union this "requestOptionsTypeName"}}] - {{/each}} -} - -{{#each options}} -type {{in.name}} = { -{{#each in.parameters}} - {{&jsdoc}} - {{{name this}}}: {{{type this}}} -{{/each}} -} -type {{out.name}} = { - method: "{{out.method}}", - url: Url, - headers: RequestHeaders, - request: RequestRequestOptions -} -{{/each}} - -{{#childParams}} -export type {{paramTypeName}} = { -{{#params}} - {{{name this}}}: {{{type this}}} -{{/params}} -}; -{{/childParams}} \ No newline at end of file diff --git a/node_modules/@octokit/types/scripts/update-endpoints/typescript.js b/node_modules/@octokit/types/scripts/update-endpoints/typescript.js deleted file mode 100644 index 2095c6c..0000000 --- a/node_modules/@octokit/types/scripts/update-endpoints/typescript.js +++ /dev/null @@ -1,179 +0,0 @@ -const { readFileSync, writeFileSync } = require("fs"); -const { resolve } = require("path"); - -const Handlebars = require("handlebars"); -const set = require("lodash.set"); -const pascalCase = require("pascal-case"); -const prettier = require("prettier"); -const { stringToJsdocComment } = require("string-to-jsdoc-comment"); -const sortKeys = require("sort-keys"); - -const ENDPOINTS = require("./generated/Endpoints.json"); -const ENDPOINTS_PATH = resolve( - process.cwd(), - "src", - "generated", - "Endpoints.ts" -); -const ENDPOINTS_TEMPLATE_PATH = resolve( - process.cwd(), - "scripts", - "update-endpoints", - "templates", - "endpoints.ts.template" -); - -Handlebars.registerHelper("union", function(endpoints, key) { - return endpoints.map(endpoint => endpoint[key]).join(" | "); -}); -Handlebars.registerHelper("name", function(parameter) { - let name = parameter.key; - - if (/[.\[]/.test(name)) { - name = `"${name}"`; - } - - if (parameter.required) { - return name; - } - - return `${name}?`; -}); - -Handlebars.registerHelper("type", function(parameter) { - const type = typeMap[parameter.type] || parameter.type; - - if (parameter.allowNull) { - return `${type} | null`; - } - - return type; -}); -const template = Handlebars.compile( - readFileSync(ENDPOINTS_TEMPLATE_PATH, "utf8") -); - -const endpointsByRoute = {}; - -const typeMap = { - integer: "number", - "integer[]": "number[]" -}; - -for (const endpoint of ENDPOINTS) { - const route = `${endpoint.method} ${endpoint.url.replace( - /\{([^}]+)}/g, - ":$1" - )}`; - - if (!endpointsByRoute[route]) { - endpointsByRoute[route] = []; - } - - endpointsByRoute[route].push({ - optionsTypeName: - pascalCase(`${endpoint.scope} ${endpoint.id}`) + "Endpoint", - requestOptionsTypeName: - pascalCase(`${endpoint.scope} ${endpoint.id}`) + "RequestOptions" - }); -} - -const options = []; -const childParams = {}; - -for (const endpoint of ENDPOINTS) { - const { method, parameters } = endpoint; - - const optionsTypeName = - pascalCase(`${endpoint.scope} ${endpoint.id}`) + "Endpoint"; - const requestOptionsTypeName = - pascalCase(`${endpoint.scope} ${endpoint.id}`) + "RequestOptions"; - - options.push({ - in: { - name: optionsTypeName, - parameters: parameters - .map(parameterize) - // handle "object" & "object[]" types - .map(parameter => { - if (parameter.deprecated) { - return; - } - - const namespacedParamsName = pascalCase( - `${endpoint.scope}.${endpoint.id}.Params` - ); - - if (parameter.type === "object" || parameter.type === "object[]") { - const childParamsName = pascalCase( - `${namespacedParamsName}.${parameter.key}` - ); - - parameter.type = parameter.type.replace("object", childParamsName); - - if (!childParams[childParamsName]) { - childParams[childParamsName] = {}; - } - } - - if (!/\./.test(parameter.key)) { - return parameter; - } - - const childKey = parameter.key.split(".").pop(); - const parentKey = parameter.key.replace(/\.[^.]+$/, ""); - - parameter.key = childKey; - - const childParamsName = pascalCase( - `${namespacedParamsName}.${parentKey}` - ); - set(childParams, `${childParamsName}.${childKey}`, parameter); - }) - .filter(Boolean) - }, - out: { - name: requestOptionsTypeName, - method - } - }); -} - -const result = template({ - endpointsByRoute: sortKeys(endpointsByRoute, { deep: true }), - options, - childParams: Object.keys(childParams).map(key => { - if (key === "GistsCreateParamsFiles") { - debugger; - } - return { - paramTypeName: key, - params: Object.values(childParams[key]) - }; - }) -}); - -writeFileSync( - ENDPOINTS_PATH, - prettier.format(result, { parser: "typescript" }) -); -console.log(`${ENDPOINTS_PATH} updated.`); - -function parameterize(parameter) { - const key = parameter.name; - const type = typeMap[parameter.type] || parameter.type; - const enums = parameter.enum - ? parameter.enum.map(JSON.stringify).join("|") - : null; - - return { - name: pascalCase(key), - key: key, - required: parameter.required, - type: enums || type, - alias: parameter.alias, - deprecated: parameter.deprecated, - allowNull: parameter.allowNull, - jsdoc: stringToJsdocComment(parameter.description) - }; -} diff --git a/node_modules/@octokit/types/src/EndpointInterface.ts b/node_modules/@octokit/types/src/EndpointInterface.ts index fee78d6..cf9f4f7 100644 --- a/node_modules/@octokit/types/src/EndpointInterface.ts +++ b/node_modules/@octokit/types/src/EndpointInterface.ts @@ -1,18 +1,21 @@ import { EndpointDefaults } from "./EndpointDefaults"; -import { EndpointOptions } from "./EndpointOptions"; import { RequestOptions } from "./RequestOptions"; import { RequestParameters } from "./RequestParameters"; import { Route } from "./Route"; import { Endpoints } from "./generated/Endpoints"; -export interface EndpointInterface { +export interface EndpointInterface { /** * Transforms a GitHub REST API endpoint into generic 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`. + * @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`. */ - (options: EndpointOptions): RequestOptions; + ( + options: O & { method?: string } & ("url" extends keyof D + ? { url?: string } + : { url: string }) + ): RequestOptions & Pick; /** * Transforms a GitHub REST API endpoint into generic request options @@ -20,22 +23,28 @@ export interface EndpointInterface { * @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`. */ - ( - route: keyof Endpoints | R, - options?: R extends keyof Endpoints - ? Endpoints[R][0] & RequestParameters + < + R extends Route, + P extends RequestParameters = R extends keyof Endpoints + ? Endpoints[R]["parameters"] & RequestParameters : RequestParameters - ): R extends keyof Endpoints ? Endpoints[R][1] : RequestOptions; + >( + route: keyof Endpoints | R, + parameters?: P + ): (R extends keyof Endpoints ? Endpoints[R]["request"] : RequestOptions) & + Pick; /** * Object with current default route and parameters */ - DEFAULTS: EndpointDefaults; + DEFAULTS: D & EndpointDefaults; /** - * Returns a new `endpoint` with updated route and parameters + * Returns a new `endpoint` interface with new defaults */ - defaults: (newDefaults: RequestParameters) => EndpointInterface; + defaults: ( + newDefaults: O + ) => EndpointInterface; merge: { /** @@ -46,7 +55,19 @@ export interface EndpointInterface { * @param {object} [parameters] URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. * */ - (route: Route, parameters?: RequestParameters): EndpointDefaults; + < + 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, @@ -54,14 +75,16 @@ export interface EndpointInterface { * * @param {object} endpoint Must set `method` and `url`. Plus URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. */ - (options: RequestParameters): EndpointDefaults; +

( + options: P + ): EndpointDefaults & D & P; /** * Returns current default options. * * @deprecated use endpoint.DEFAULTS instead */ - (): EndpointDefaults; + (): D & EndpointDefaults; }; /** @@ -70,5 +93,7 @@ export interface EndpointInterface { * * @param {object} options `method`, `url`. Plus URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. */ - parse: (options: EndpointDefaults) => RequestOptions; + parse: ( + options: O + ) => RequestOptions & Pick; } diff --git a/node_modules/@octokit/types/src/RequestInterface.ts b/node_modules/@octokit/types/src/RequestInterface.ts index bc4c74f..78e03c2 100644 --- a/node_modules/@octokit/types/src/RequestInterface.ts +++ b/node_modules/@octokit/types/src/RequestInterface.ts @@ -1,16 +1,21 @@ import { EndpointInterface } from "./EndpointInterface"; -import { EndpointOptions } from "./EndpointOptions"; import { OctokitResponse } from "./OctokitResponse"; import { RequestParameters } from "./RequestParameters"; import { Route } from "./Route"; -export interface RequestInterface { +import { Endpoints } from "./generated/Endpoints"; + +export interface RequestInterface { /** * 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`. */ - (options: EndpointOptions): Promise>; + ( + options: O & { method?: string } & ("url" extends keyof D + ? { url?: string } + : { url: string }) + ): Promise>; /** * Sends a request based on endpoint options @@ -18,17 +23,24 @@ export interface RequestInterface { * @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`. */ - (route: Route, parameters?: RequestParameters): Promise< - OctokitResponse - >; + ( + route: keyof Endpoints | R, + options?: R extends keyof Endpoints + ? Endpoints[R]["parameters"] & RequestParameters + : RequestParameters + ): R extends keyof Endpoints + ? Promise + : Promise>; /** - * Returns a new `endpoint` with updated route and parameters + * Returns a new `request` with updated route and parameters */ - defaults: (newDefaults: RequestParameters) => RequestInterface; + defaults: ( + newDefaults: O + ) => RequestInterface; /** * Octokit endpoint API, see {@link https://github.com/octokit/endpoint.js|@octokit/endpoint} */ - endpoint: EndpointInterface; + endpoint: EndpointInterface; } diff --git a/node_modules/@octokit/types/src/RequestParameters.ts b/node_modules/@octokit/types/src/RequestParameters.ts index 9766be0..703e9a3 100644 --- a/node_modules/@octokit/types/src/RequestParameters.ts +++ b/node_modules/@octokit/types/src/RequestParameters.ts @@ -42,5 +42,5 @@ export type RequestParameters = { * 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]: any; + [parameter: string]: unknown; }; diff --git a/node_modules/@octokit/types/src/VERSION.ts b/node_modules/@octokit/types/src/VERSION.ts index 6c49faf..b678238 100644 --- a/node_modules/@octokit/types/src/VERSION.ts +++ b/node_modules/@octokit/types/src/VERSION.ts @@ -1 +1 @@ -export const VERSION = "2.0.2"; +export const VERSION = "2.14.0"; diff --git a/node_modules/@octokit/types/src/generated/Endpoints.ts b/node_modules/@octokit/types/src/generated/Endpoints.ts index 3aec914..3181168 100644 --- a/node_modules/@octokit/types/src/generated/Endpoints.ts +++ b/node_modules/@octokit/types/src/generated/Endpoints.ts @@ -1,2027 +1,5084 @@ // DO NOT EDIT THIS FILE +import { OctokitResponse } from "../OctokitResponse"; import { RequestHeaders } from "../RequestHeaders"; import { RequestRequestOptions } from "../RequestRequestOptions"; -import { Url } from "../Url"; + +type RequiredPreview = { + mediaType: { + previews: [T, ...string[]]; + }; +}; export interface Endpoints { - "DELETE /app/installations/:installation_id": [ - AppsDeleteInstallationEndpoint, - AppsDeleteInstallationRequestOptions - ]; - "DELETE /applications/:client_id/grants/:access_token": [ - OauthAuthorizationsRevokeGrantForApplicationEndpoint, - OauthAuthorizationsRevokeGrantForApplicationRequestOptions - ]; - "DELETE /applications/:client_id/tokens/:access_token": [ - OauthAuthorizationsRevokeAuthorizationForApplicationEndpoint, - OauthAuthorizationsRevokeAuthorizationForApplicationRequestOptions - ]; - "DELETE /applications/grants/:grant_id": [ - OauthAuthorizationsDeleteGrantEndpoint, - OauthAuthorizationsDeleteGrantRequestOptions - ]; - "DELETE /authorizations/:authorization_id": [ - OauthAuthorizationsDeleteAuthorizationEndpoint, - OauthAuthorizationsDeleteAuthorizationRequestOptions - ]; - "DELETE /gists/:gist_id": [GistsDeleteEndpoint, GistsDeleteRequestOptions]; - "DELETE /gists/:gist_id/comments/:comment_id": [ - GistsDeleteCommentEndpoint, - GistsDeleteCommentRequestOptions - ]; - "DELETE /gists/:gist_id/star": [ - GistsUnstarEndpoint, - GistsUnstarRequestOptions - ]; - "DELETE /notifications/threads/:thread_id/subscription": [ - ActivityDeleteThreadSubscriptionEndpoint, - ActivityDeleteThreadSubscriptionRequestOptions - ]; - "DELETE /orgs/:org/blocks/:username": [ - OrgsUnblockUserEndpoint, - OrgsUnblockUserRequestOptions - ]; - "DELETE /orgs/:org/credential-authorizations/:credential_id": [ - OrgsRemoveCredentialAuthorizationEndpoint, - OrgsRemoveCredentialAuthorizationRequestOptions - ]; - "DELETE /orgs/:org/hooks/:hook_id": [ - OrgsDeleteHookEndpoint, - OrgsDeleteHookRequestOptions - ]; - "DELETE /orgs/:org/interaction-limits": [ - InteractionsRemoveRestrictionsForOrgEndpoint, - InteractionsRemoveRestrictionsForOrgRequestOptions - ]; - "DELETE /orgs/:org/members/:username": [ - OrgsRemoveMemberEndpoint, - OrgsRemoveMemberRequestOptions - ]; - "DELETE /orgs/:org/memberships/:username": [ - OrgsRemoveMembershipEndpoint, - OrgsRemoveMembershipRequestOptions - ]; - "DELETE /orgs/:org/migrations/:migration_id/archive": [ - MigrationsDeleteArchiveForOrgEndpoint, - MigrationsDeleteArchiveForOrgRequestOptions - ]; - "DELETE /orgs/:org/migrations/:migration_id/repos/:repo_name/lock": [ - MigrationsUnlockRepoForOrgEndpoint, - MigrationsUnlockRepoForOrgRequestOptions - ]; - "DELETE /orgs/:org/outside_collaborators/:username": [ - OrgsRemoveOutsideCollaboratorEndpoint, - OrgsRemoveOutsideCollaboratorRequestOptions - ]; - "DELETE /orgs/:org/public_members/:username": [ - OrgsConcealMembershipEndpoint, - OrgsConcealMembershipRequestOptions - ]; - "DELETE /projects/:project_id": [ - ProjectsDeleteEndpoint, - ProjectsDeleteRequestOptions - ]; - "DELETE /projects/:project_id/collaborators/:username": [ - ProjectsRemoveCollaboratorEndpoint, - ProjectsRemoveCollaboratorRequestOptions - ]; - "DELETE /projects/columns/:column_id": [ - ProjectsDeleteColumnEndpoint, - ProjectsDeleteColumnRequestOptions - ]; - "DELETE /projects/columns/cards/:card_id": [ - ProjectsDeleteCardEndpoint, - ProjectsDeleteCardRequestOptions - ]; - "DELETE /reactions/:reaction_id": [ - ReactionsDeleteEndpoint, - ReactionsDeleteRequestOptions - ]; - "DELETE /repos/:owner/:repo": [ - ReposDeleteEndpoint, - ReposDeleteRequestOptions - ]; - "DELETE /repos/:owner/:repo/automated-security-fixes": [ - ReposDisableAutomatedSecurityFixesEndpoint, - ReposDisableAutomatedSecurityFixesRequestOptions - ]; - "DELETE /repos/:owner/:repo/branches/:branch/protection": [ - ReposRemoveBranchProtectionEndpoint, - ReposRemoveBranchProtectionRequestOptions - ]; - "DELETE /repos/:owner/:repo/branches/:branch/protection/enforce_admins": [ - ReposRemoveProtectedBranchAdminEnforcementEndpoint, - ReposRemoveProtectedBranchAdminEnforcementRequestOptions - ]; - "DELETE /repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews": [ - ReposRemoveProtectedBranchPullRequestReviewEnforcementEndpoint, - ReposRemoveProtectedBranchPullRequestReviewEnforcementRequestOptions - ]; - "DELETE /repos/:owner/:repo/branches/:branch/protection/required_signatures": [ - ReposRemoveProtectedBranchRequiredSignaturesEndpoint, - ReposRemoveProtectedBranchRequiredSignaturesRequestOptions - ]; - "DELETE /repos/:owner/:repo/branches/:branch/protection/required_status_checks": [ - ReposRemoveProtectedBranchRequiredStatusChecksEndpoint, - ReposRemoveProtectedBranchRequiredStatusChecksRequestOptions - ]; - "DELETE /repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts": [ - ReposRemoveProtectedBranchRequiredStatusChecksContextsEndpoint, - ReposRemoveProtectedBranchRequiredStatusChecksContextsRequestOptions - ]; - "DELETE /repos/:owner/:repo/branches/:branch/protection/restrictions": [ - ReposRemoveProtectedBranchRestrictionsEndpoint, - ReposRemoveProtectedBranchRestrictionsRequestOptions - ]; - "DELETE /repos/:owner/:repo/branches/:branch/protection/restrictions/apps": [ - ReposRemoveProtectedBranchAppRestrictionsEndpoint, - ReposRemoveProtectedBranchAppRestrictionsRequestOptions - ]; - "DELETE /repos/:owner/:repo/branches/:branch/protection/restrictions/teams": [ - ReposRemoveProtectedBranchTeamRestrictionsEndpoint, - ReposRemoveProtectedBranchTeamRestrictionsRequestOptions - ]; - "DELETE /repos/:owner/:repo/branches/:branch/protection/restrictions/users": [ - ReposRemoveProtectedBranchUserRestrictionsEndpoint, - ReposRemoveProtectedBranchUserRestrictionsRequestOptions - ]; - "DELETE /repos/:owner/:repo/collaborators/:username": [ - ReposRemoveCollaboratorEndpoint, - ReposRemoveCollaboratorRequestOptions - ]; - "DELETE /repos/:owner/:repo/comments/:comment_id": [ - ReposDeleteCommitCommentEndpoint, - ReposDeleteCommitCommentRequestOptions - ]; - "DELETE /repos/:owner/:repo/contents/:path": [ - ReposDeleteFileEndpoint, - ReposDeleteFileRequestOptions - ]; - "DELETE /repos/:owner/:repo/downloads/:download_id": [ - ReposDeleteDownloadEndpoint, - ReposDeleteDownloadRequestOptions - ]; - "DELETE /repos/:owner/:repo/git/refs/:ref": [ - GitDeleteRefEndpoint, - GitDeleteRefRequestOptions - ]; - "DELETE /repos/:owner/:repo/hooks/:hook_id": [ - ReposDeleteHookEndpoint, - ReposDeleteHookRequestOptions - ]; - "DELETE /repos/:owner/:repo/import": [ - MigrationsCancelImportEndpoint, - MigrationsCancelImportRequestOptions - ]; - "DELETE /repos/:owner/:repo/interaction-limits": [ - InteractionsRemoveRestrictionsForRepoEndpoint, - InteractionsRemoveRestrictionsForRepoRequestOptions - ]; - "DELETE /repos/:owner/:repo/invitations/:invitation_id": [ - ReposDeleteInvitationEndpoint, - ReposDeleteInvitationRequestOptions - ]; - "DELETE /repos/:owner/:repo/issues/:issue_number/assignees": [ - IssuesRemoveAssigneesEndpoint, - IssuesRemoveAssigneesRequestOptions - ]; - "DELETE /repos/:owner/:repo/issues/:issue_number/labels": [ - IssuesRemoveLabelsEndpoint, - IssuesRemoveLabelsRequestOptions - ]; - "DELETE /repos/:owner/:repo/issues/:issue_number/labels/:name": [ - IssuesRemoveLabelEndpoint, - IssuesRemoveLabelRequestOptions - ]; - "DELETE /repos/:owner/:repo/issues/:issue_number/lock": [ - IssuesUnlockEndpoint, - IssuesUnlockRequestOptions - ]; - "DELETE /repos/:owner/:repo/issues/comments/:comment_id": [ - IssuesDeleteCommentEndpoint, - IssuesDeleteCommentRequestOptions - ]; - "DELETE /repos/:owner/:repo/keys/:key_id": [ - ReposRemoveDeployKeyEndpoint, - ReposRemoveDeployKeyRequestOptions - ]; - "DELETE /repos/:owner/:repo/labels/:name": [ - IssuesDeleteLabelEndpoint, - IssuesDeleteLabelRequestOptions - ]; - "DELETE /repos/:owner/:repo/milestones/:milestone_number": [ - IssuesDeleteMilestoneEndpoint, - IssuesDeleteMilestoneRequestOptions - ]; - "DELETE /repos/:owner/:repo/pages": [ - ReposDisablePagesSiteEndpoint, - ReposDisablePagesSiteRequestOptions - ]; - "DELETE /repos/:owner/:repo/pulls/:pull_number/requested_reviewers": [ - PullsDeleteReviewRequestEndpoint, - PullsDeleteReviewRequestRequestOptions - ]; - "DELETE /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id": [ - PullsDeletePendingReviewEndpoint, - PullsDeletePendingReviewRequestOptions - ]; - "DELETE /repos/:owner/:repo/pulls/comments/:comment_id": [ - PullsDeleteCommentEndpoint, - PullsDeleteCommentRequestOptions - ]; - "DELETE /repos/:owner/:repo/releases/:release_id": [ - ReposDeleteReleaseEndpoint, - ReposDeleteReleaseRequestOptions - ]; - "DELETE /repos/:owner/:repo/releases/assets/:asset_id": [ - ReposDeleteReleaseAssetEndpoint, - ReposDeleteReleaseAssetRequestOptions - ]; - "DELETE /repos/:owner/:repo/subscription": [ - ActivityDeleteRepoSubscriptionEndpoint, - ActivityDeleteRepoSubscriptionRequestOptions - ]; - "DELETE /repos/:owner/:repo/vulnerability-alerts": [ - ReposDisableVulnerabilityAlertsEndpoint, - ReposDisableVulnerabilityAlertsRequestOptions - ]; - "DELETE /scim/v2/organizations/:org/Users/:scim_user_id": [ - ScimRemoveUserFromOrgEndpoint, - ScimRemoveUserFromOrgRequestOptions - ]; - "DELETE /teams/:team_id": [TeamsDeleteEndpoint, TeamsDeleteRequestOptions]; - "DELETE /teams/:team_id/discussions/:discussion_number": [ - TeamsDeleteDiscussionEndpoint, - TeamsDeleteDiscussionRequestOptions - ]; - "DELETE /teams/:team_id/discussions/:discussion_number/comments/:comment_number": [ - TeamsDeleteDiscussionCommentEndpoint, - TeamsDeleteDiscussionCommentRequestOptions - ]; - "DELETE /teams/:team_id/members/:username": [ - TeamsRemoveMemberEndpoint, - TeamsRemoveMemberRequestOptions - ]; - "DELETE /teams/:team_id/memberships/:username": [ - TeamsRemoveMembershipEndpoint, - TeamsRemoveMembershipRequestOptions - ]; - "DELETE /teams/:team_id/projects/:project_id": [ - TeamsRemoveProjectEndpoint, - TeamsRemoveProjectRequestOptions - ]; - "DELETE /teams/:team_id/repos/:owner/:repo": [ - TeamsRemoveRepoEndpoint, - TeamsRemoveRepoRequestOptions - ]; - "DELETE /user/blocks/:username": [ - UsersUnblockEndpoint, - UsersUnblockRequestOptions - ]; - "DELETE /user/emails": [ - UsersDeleteEmailsEndpoint, - UsersDeleteEmailsRequestOptions - ]; - "DELETE /user/following/:username": [ - UsersUnfollowEndpoint, - UsersUnfollowRequestOptions - ]; - "DELETE /user/gpg_keys/:gpg_key_id": [ - UsersDeleteGpgKeyEndpoint, - UsersDeleteGpgKeyRequestOptions - ]; - "DELETE /user/installations/:installation_id/repositories/:repository_id": [ - AppsRemoveRepoFromInstallationEndpoint, - AppsRemoveRepoFromInstallationRequestOptions - ]; - "DELETE /user/keys/:key_id": [ - UsersDeletePublicKeyEndpoint, - UsersDeletePublicKeyRequestOptions - ]; - "DELETE /user/migrations/:migration_id/archive": [ - MigrationsDeleteArchiveForAuthenticatedUserEndpoint, - MigrationsDeleteArchiveForAuthenticatedUserRequestOptions - ]; - "DELETE /user/migrations/:migration_id/repos/:repo_name/lock": [ - MigrationsUnlockRepoForAuthenticatedUserEndpoint, - MigrationsUnlockRepoForAuthenticatedUserRequestOptions - ]; - "DELETE /user/repository_invitations/:invitation_id": [ - ReposDeclineInvitationEndpoint, - ReposDeclineInvitationRequestOptions - ]; - "DELETE /user/starred/:owner/:repo": [ - ActivityUnstarRepoEndpoint, - ActivityUnstarRepoRequestOptions - ]; - "DELETE /user/subscriptions/:owner/:repo": [ - ActivityStopWatchingRepoLegacyEndpoint, - ActivityStopWatchingRepoLegacyRequestOptions - ]; - "GET /app": [ - AppsGetAuthenticatedEndpoint, - AppsGetAuthenticatedRequestOptions - ]; - "GET /app/installations": [ - AppsListInstallationsEndpoint, - AppsListInstallationsRequestOptions - ]; - "GET /app/installations/:installation_id": [ - AppsGetInstallationEndpoint, - AppsGetInstallationRequestOptions - ]; - "GET /applications/:client_id/tokens/:access_token": [ - OauthAuthorizationsCheckAuthorizationEndpoint, - OauthAuthorizationsCheckAuthorizationRequestOptions - ]; - "GET /applications/grants": [ - OauthAuthorizationsListGrantsEndpoint, - OauthAuthorizationsListGrantsRequestOptions - ]; - "GET /applications/grants/:grant_id": [ - OauthAuthorizationsGetGrantEndpoint, - OauthAuthorizationsGetGrantRequestOptions - ]; - "GET /apps/:app_slug": [AppsGetBySlugEndpoint, AppsGetBySlugRequestOptions]; - "GET /authorizations": [ - OauthAuthorizationsListAuthorizationsEndpoint, - OauthAuthorizationsListAuthorizationsRequestOptions - ]; - "GET /authorizations/:authorization_id": [ - OauthAuthorizationsGetAuthorizationEndpoint, - OauthAuthorizationsGetAuthorizationRequestOptions - ]; - "GET /codes_of_conduct": [ - CodesOfConductListConductCodesEndpoint, - CodesOfConductListConductCodesRequestOptions - ]; - "GET /codes_of_conduct/:key": [ - CodesOfConductGetConductCodeEndpoint, - CodesOfConductGetConductCodeRequestOptions - ]; - "GET /emojis": [EmojisGetEndpoint, EmojisGetRequestOptions]; - "GET /events": [ - ActivityListPublicEventsEndpoint, - ActivityListPublicEventsRequestOptions - ]; - "GET /feeds": [ActivityListFeedsEndpoint, ActivityListFeedsRequestOptions]; - "GET /gists": [GistsListEndpoint, GistsListRequestOptions]; - "GET /gists/:gist_id": [GistsGetEndpoint, GistsGetRequestOptions]; - "GET /gists/:gist_id/:sha": [ - GistsGetRevisionEndpoint, - GistsGetRevisionRequestOptions - ]; - "GET /gists/:gist_id/comments": [ - GistsListCommentsEndpoint, - GistsListCommentsRequestOptions - ]; - "GET /gists/:gist_id/comments/:comment_id": [ - GistsGetCommentEndpoint, - GistsGetCommentRequestOptions - ]; - "GET /gists/:gist_id/commits": [ - GistsListCommitsEndpoint, - GistsListCommitsRequestOptions - ]; - "GET /gists/:gist_id/forks": [ - GistsListForksEndpoint, - GistsListForksRequestOptions - ]; - "GET /gists/:gist_id/star": [ - GistsCheckIsStarredEndpoint, - GistsCheckIsStarredRequestOptions - ]; - "GET /gists/public": [GistsListPublicEndpoint, GistsListPublicRequestOptions]; - "GET /gists/starred": [ - GistsListStarredEndpoint, - GistsListStarredRequestOptions - ]; - "GET /gitignore/templates": [ - GitignoreListTemplatesEndpoint, - GitignoreListTemplatesRequestOptions - ]; - "GET /gitignore/templates/:name": [ - GitignoreGetTemplateEndpoint, - GitignoreGetTemplateRequestOptions - ]; - "GET /installation/repositories": [ - AppsListReposEndpoint, - AppsListReposRequestOptions - ]; - "GET /issues": [IssuesListEndpoint, IssuesListRequestOptions]; - "GET /legacy/issues/search/:owner/:repository/:state/:keyword": [ - SearchIssuesLegacyEndpoint, - SearchIssuesLegacyRequestOptions - ]; - "GET /legacy/repos/search/:keyword": [ - SearchReposLegacyEndpoint, - SearchReposLegacyRequestOptions - ]; - "GET /legacy/user/email/:email": [ - SearchEmailLegacyEndpoint, - SearchEmailLegacyRequestOptions - ]; - "GET /legacy/user/search/:keyword": [ - SearchUsersLegacyEndpoint, - SearchUsersLegacyRequestOptions - ]; - "GET /licenses": [ - LicensesListCommonlyUsedEndpoint | LicensesListEndpoint, - LicensesListCommonlyUsedRequestOptions | LicensesListRequestOptions - ]; - "GET /licenses/:license": [LicensesGetEndpoint, LicensesGetRequestOptions]; - "GET /marketplace_listing/accounts/:account_id": [ - AppsCheckAccountIsAssociatedWithAnyEndpoint, - AppsCheckAccountIsAssociatedWithAnyRequestOptions - ]; - "GET /marketplace_listing/plans": [ - AppsListPlansEndpoint, - AppsListPlansRequestOptions - ]; - "GET /marketplace_listing/plans/:plan_id/accounts": [ - AppsListAccountsUserOrOrgOnPlanEndpoint, - AppsListAccountsUserOrOrgOnPlanRequestOptions - ]; - "GET /marketplace_listing/stubbed/accounts/:account_id": [ - AppsCheckAccountIsAssociatedWithAnyStubbedEndpoint, - AppsCheckAccountIsAssociatedWithAnyStubbedRequestOptions - ]; - "GET /marketplace_listing/stubbed/plans": [ - AppsListPlansStubbedEndpoint, - AppsListPlansStubbedRequestOptions - ]; - "GET /marketplace_listing/stubbed/plans/:plan_id/accounts": [ - AppsListAccountsUserOrOrgOnPlanStubbedEndpoint, - AppsListAccountsUserOrOrgOnPlanStubbedRequestOptions - ]; - "GET /meta": [MetaGetEndpoint, MetaGetRequestOptions]; - "GET /networks/:owner/:repo/events": [ - ActivityListPublicEventsForRepoNetworkEndpoint, - ActivityListPublicEventsForRepoNetworkRequestOptions - ]; - "GET /notifications": [ - ActivityListNotificationsEndpoint, - ActivityListNotificationsRequestOptions - ]; - "GET /notifications/threads/:thread_id": [ - ActivityGetThreadEndpoint, - ActivityGetThreadRequestOptions - ]; - "GET /notifications/threads/:thread_id/subscription": [ - ActivityGetThreadSubscriptionEndpoint, - ActivityGetThreadSubscriptionRequestOptions - ]; - "GET /organizations": [OrgsListEndpoint, OrgsListRequestOptions]; - "GET /orgs/:org": [OrgsGetEndpoint, OrgsGetRequestOptions]; - "GET /orgs/:org/blocks": [ - OrgsListBlockedUsersEndpoint, - OrgsListBlockedUsersRequestOptions - ]; - "GET /orgs/:org/blocks/:username": [ - OrgsCheckBlockedUserEndpoint, - OrgsCheckBlockedUserRequestOptions - ]; - "GET /orgs/:org/credential-authorizations": [ - OrgsListCredentialAuthorizationsEndpoint, - OrgsListCredentialAuthorizationsRequestOptions - ]; - "GET /orgs/:org/events": [ - ActivityListPublicEventsForOrgEndpoint, - ActivityListPublicEventsForOrgRequestOptions - ]; - "GET /orgs/:org/hooks": [OrgsListHooksEndpoint, OrgsListHooksRequestOptions]; - "GET /orgs/:org/hooks/:hook_id": [ - OrgsGetHookEndpoint, - OrgsGetHookRequestOptions - ]; - "GET /orgs/:org/installation": [ - AppsGetOrgInstallationEndpoint | AppsFindOrgInstallationEndpoint, - AppsGetOrgInstallationRequestOptions | AppsFindOrgInstallationRequestOptions - ]; - "GET /orgs/:org/interaction-limits": [ - InteractionsGetRestrictionsForOrgEndpoint, - InteractionsGetRestrictionsForOrgRequestOptions - ]; - "GET /orgs/:org/invitations": [ - OrgsListPendingInvitationsEndpoint, - OrgsListPendingInvitationsRequestOptions - ]; - "GET /orgs/:org/invitations/:invitation_id/teams": [ - OrgsListInvitationTeamsEndpoint, - OrgsListInvitationTeamsRequestOptions - ]; - "GET /orgs/:org/issues": [ - IssuesListForOrgEndpoint, - IssuesListForOrgRequestOptions - ]; - "GET /orgs/:org/members": [ - OrgsListMembersEndpoint, - OrgsListMembersRequestOptions - ]; - "GET /orgs/:org/members/:username": [ - OrgsCheckMembershipEndpoint, - OrgsCheckMembershipRequestOptions - ]; - "GET /orgs/:org/memberships/:username": [ - OrgsGetMembershipEndpoint, - OrgsGetMembershipRequestOptions - ]; - "GET /orgs/:org/migrations": [ - MigrationsListForOrgEndpoint, - MigrationsListForOrgRequestOptions - ]; - "GET /orgs/:org/migrations/:migration_id": [ - MigrationsGetStatusForOrgEndpoint, - MigrationsGetStatusForOrgRequestOptions - ]; - "GET /orgs/:org/migrations/:migration_id/archive": [ - MigrationsGetArchiveForOrgEndpoint, - MigrationsGetArchiveForOrgRequestOptions - ]; - "GET /orgs/:org/outside_collaborators": [ - OrgsListOutsideCollaboratorsEndpoint, - OrgsListOutsideCollaboratorsRequestOptions - ]; - "GET /orgs/:org/projects": [ - ProjectsListForOrgEndpoint, - ProjectsListForOrgRequestOptions - ]; - "GET /orgs/:org/public_members": [ - OrgsListPublicMembersEndpoint, - OrgsListPublicMembersRequestOptions - ]; - "GET /orgs/:org/public_members/:username": [ - OrgsCheckPublicMembershipEndpoint, - OrgsCheckPublicMembershipRequestOptions - ]; - "GET /orgs/:org/repos": [ - ReposListForOrgEndpoint, - ReposListForOrgRequestOptions - ]; - "GET /orgs/:org/team-sync/groups": [ - TeamsListIdPGroupsForOrgEndpoint, - TeamsListIdPGroupsForOrgRequestOptions - ]; - "GET /orgs/:org/teams": [TeamsListEndpoint, TeamsListRequestOptions]; - "GET /orgs/:org/teams/:team_slug": [ - TeamsGetByNameEndpoint, - TeamsGetByNameRequestOptions - ]; - "GET /projects/:project_id": [ProjectsGetEndpoint, ProjectsGetRequestOptions]; - "GET /projects/:project_id/collaborators": [ - ProjectsListCollaboratorsEndpoint, - ProjectsListCollaboratorsRequestOptions - ]; - "GET /projects/:project_id/collaborators/:username/permission": [ - ProjectsReviewUserPermissionLevelEndpoint, - ProjectsReviewUserPermissionLevelRequestOptions - ]; - "GET /projects/:project_id/columns": [ - ProjectsListColumnsEndpoint, - ProjectsListColumnsRequestOptions - ]; - "GET /projects/columns/:column_id": [ - ProjectsGetColumnEndpoint, - ProjectsGetColumnRequestOptions - ]; - "GET /projects/columns/:column_id/cards": [ - ProjectsListCardsEndpoint, - ProjectsListCardsRequestOptions - ]; - "GET /projects/columns/cards/:card_id": [ - ProjectsGetCardEndpoint, - ProjectsGetCardRequestOptions - ]; - "GET /rate_limit": [RateLimitGetEndpoint, RateLimitGetRequestOptions]; - "GET /repos/:owner/:repo": [ReposGetEndpoint, ReposGetRequestOptions]; - "GET /repos/:owner/:repo/:archive_format/:ref": [ - ReposGetArchiveLinkEndpoint, - ReposGetArchiveLinkRequestOptions - ]; - "GET /repos/:owner/:repo/assignees": [ - IssuesListAssigneesEndpoint, - IssuesListAssigneesRequestOptions - ]; - "GET /repos/:owner/:repo/assignees/:assignee": [ - IssuesCheckAssigneeEndpoint, - IssuesCheckAssigneeRequestOptions - ]; - "GET /repos/:owner/:repo/branches": [ - ReposListBranchesEndpoint, - ReposListBranchesRequestOptions - ]; - "GET /repos/:owner/:repo/branches/:branch": [ - ReposGetBranchEndpoint, - ReposGetBranchRequestOptions - ]; - "GET /repos/:owner/:repo/branches/:branch/protection": [ - ReposGetBranchProtectionEndpoint, - ReposGetBranchProtectionRequestOptions - ]; - "GET /repos/:owner/:repo/branches/:branch/protection/enforce_admins": [ - ReposGetProtectedBranchAdminEnforcementEndpoint, - ReposGetProtectedBranchAdminEnforcementRequestOptions - ]; - "GET /repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews": [ - ReposGetProtectedBranchPullRequestReviewEnforcementEndpoint, - ReposGetProtectedBranchPullRequestReviewEnforcementRequestOptions - ]; - "GET /repos/:owner/:repo/branches/:branch/protection/required_signatures": [ - ReposGetProtectedBranchRequiredSignaturesEndpoint, - ReposGetProtectedBranchRequiredSignaturesRequestOptions - ]; - "GET /repos/:owner/:repo/branches/:branch/protection/required_status_checks": [ - ReposGetProtectedBranchRequiredStatusChecksEndpoint, - ReposGetProtectedBranchRequiredStatusChecksRequestOptions - ]; - "GET /repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts": [ - ReposListProtectedBranchRequiredStatusChecksContextsEndpoint, - ReposListProtectedBranchRequiredStatusChecksContextsRequestOptions - ]; - "GET /repos/:owner/:repo/branches/:branch/protection/restrictions": [ - ReposGetProtectedBranchRestrictionsEndpoint, - ReposGetProtectedBranchRestrictionsRequestOptions - ]; - "GET /repos/:owner/:repo/branches/:branch/protection/restrictions/apps": [ - - | ReposGetAppsWithAccessToProtectedBranchEndpoint - | ReposListAppsWithAccessToProtectedBranchEndpoint, - - | ReposGetAppsWithAccessToProtectedBranchRequestOptions - | ReposListAppsWithAccessToProtectedBranchRequestOptions - ]; - "GET /repos/:owner/:repo/branches/:branch/protection/restrictions/teams": [ - - | ReposGetTeamsWithAccessToProtectedBranchEndpoint - | ReposListProtectedBranchTeamRestrictionsEndpoint - | ReposListTeamsWithAccessToProtectedBranchEndpoint, - - | ReposGetTeamsWithAccessToProtectedBranchRequestOptions - | ReposListProtectedBranchTeamRestrictionsRequestOptions - | ReposListTeamsWithAccessToProtectedBranchRequestOptions - ]; - "GET /repos/:owner/:repo/branches/:branch/protection/restrictions/users": [ - - | ReposGetUsersWithAccessToProtectedBranchEndpoint - | ReposListProtectedBranchUserRestrictionsEndpoint - | ReposListUsersWithAccessToProtectedBranchEndpoint, - - | ReposGetUsersWithAccessToProtectedBranchRequestOptions - | ReposListProtectedBranchUserRestrictionsRequestOptions - | ReposListUsersWithAccessToProtectedBranchRequestOptions - ]; - "GET /repos/:owner/:repo/check-runs/:check_run_id": [ - ChecksGetEndpoint, - ChecksGetRequestOptions - ]; - "GET /repos/:owner/:repo/check-runs/:check_run_id/annotations": [ - ChecksListAnnotationsEndpoint, - ChecksListAnnotationsRequestOptions - ]; - "GET /repos/:owner/:repo/check-suites/:check_suite_id": [ - ChecksGetSuiteEndpoint, - ChecksGetSuiteRequestOptions - ]; - "GET /repos/:owner/:repo/check-suites/:check_suite_id/check-runs": [ - ChecksListForSuiteEndpoint, - ChecksListForSuiteRequestOptions - ]; - "GET /repos/:owner/:repo/collaborators": [ - ReposListCollaboratorsEndpoint, - ReposListCollaboratorsRequestOptions - ]; - "GET /repos/:owner/:repo/collaborators/:username": [ - ReposCheckCollaboratorEndpoint, - ReposCheckCollaboratorRequestOptions - ]; - "GET /repos/:owner/:repo/collaborators/:username/permission": [ - ReposGetCollaboratorPermissionLevelEndpoint, - ReposGetCollaboratorPermissionLevelRequestOptions - ]; - "GET /repos/:owner/:repo/comments": [ - ReposListCommitCommentsEndpoint, - ReposListCommitCommentsRequestOptions - ]; - "GET /repos/:owner/:repo/comments/:comment_id": [ - ReposGetCommitCommentEndpoint, - ReposGetCommitCommentRequestOptions - ]; - "GET /repos/:owner/:repo/comments/:comment_id/reactions": [ - ReactionsListForCommitCommentEndpoint, - ReactionsListForCommitCommentRequestOptions - ]; - "GET /repos/:owner/:repo/commits": [ - ReposListCommitsEndpoint, - ReposListCommitsRequestOptions - ]; - "GET /repos/:owner/:repo/commits/:commit_sha/branches-where-head": [ - ReposListBranchesForHeadCommitEndpoint, - ReposListBranchesForHeadCommitRequestOptions - ]; - "GET /repos/:owner/:repo/commits/:commit_sha/comments": [ - ReposListCommentsForCommitEndpoint, - ReposListCommentsForCommitRequestOptions - ]; - "GET /repos/:owner/:repo/commits/:commit_sha/pulls": [ - ReposListPullRequestsAssociatedWithCommitEndpoint, - ReposListPullRequestsAssociatedWithCommitRequestOptions - ]; - "GET /repos/:owner/:repo/commits/:ref": [ - ReposGetCommitEndpoint, - ReposGetCommitRequestOptions - ]; - "GET /repos/:owner/:repo/commits/:ref/check-runs": [ - ChecksListForRefEndpoint, - ChecksListForRefRequestOptions - ]; - "GET /repos/:owner/:repo/commits/:ref/check-suites": [ - ChecksListSuitesForRefEndpoint, - ChecksListSuitesForRefRequestOptions - ]; - "GET /repos/:owner/:repo/commits/:ref/status": [ - ReposGetCombinedStatusForRefEndpoint, - ReposGetCombinedStatusForRefRequestOptions - ]; - "GET /repos/:owner/:repo/commits/:ref/statuses": [ - ReposListStatusesForRefEndpoint, - ReposListStatusesForRefRequestOptions - ]; - "GET /repos/:owner/:repo/community/code_of_conduct": [ - CodesOfConductGetForRepoEndpoint, - CodesOfConductGetForRepoRequestOptions - ]; - "GET /repos/:owner/:repo/community/profile": [ - ReposRetrieveCommunityProfileMetricsEndpoint, - ReposRetrieveCommunityProfileMetricsRequestOptions - ]; - "GET /repos/:owner/:repo/compare/:base...:head": [ - ReposCompareCommitsEndpoint, - ReposCompareCommitsRequestOptions - ]; - "GET /repos/:owner/:repo/contents/:path": [ - ReposGetContentsEndpoint, - ReposGetContentsRequestOptions - ]; - "GET /repos/:owner/:repo/contributors": [ - ReposListContributorsEndpoint, - ReposListContributorsRequestOptions - ]; - "GET /repos/:owner/:repo/deployments": [ - ReposListDeploymentsEndpoint, - ReposListDeploymentsRequestOptions - ]; - "GET /repos/:owner/:repo/deployments/:deployment_id": [ - ReposGetDeploymentEndpoint, - ReposGetDeploymentRequestOptions - ]; - "GET /repos/:owner/:repo/deployments/:deployment_id/statuses": [ - ReposListDeploymentStatusesEndpoint, - ReposListDeploymentStatusesRequestOptions - ]; - "GET /repos/:owner/:repo/deployments/:deployment_id/statuses/:status_id": [ - ReposGetDeploymentStatusEndpoint, - ReposGetDeploymentStatusRequestOptions - ]; - "GET /repos/:owner/:repo/downloads": [ - ReposListDownloadsEndpoint, - ReposListDownloadsRequestOptions - ]; - "GET /repos/:owner/:repo/downloads/:download_id": [ - ReposGetDownloadEndpoint, - ReposGetDownloadRequestOptions - ]; - "GET /repos/:owner/:repo/events": [ - ActivityListRepoEventsEndpoint, - ActivityListRepoEventsRequestOptions - ]; - "GET /repos/:owner/:repo/forks": [ - ReposListForksEndpoint, - ReposListForksRequestOptions - ]; - "GET /repos/:owner/:repo/git/blobs/:file_sha": [ - GitGetBlobEndpoint, - GitGetBlobRequestOptions - ]; - "GET /repos/:owner/:repo/git/commits/:commit_sha": [ - GitGetCommitEndpoint, - GitGetCommitRequestOptions - ]; - "GET /repos/:owner/:repo/git/matching-refs/:ref": [ - GitListMatchingRefsEndpoint, - GitListMatchingRefsRequestOptions - ]; - "GET /repos/:owner/:repo/git/ref/:ref": [ - GitGetRefEndpoint, - GitGetRefRequestOptions - ]; - "GET /repos/:owner/:repo/git/tags/:tag_sha": [ - GitGetTagEndpoint, - GitGetTagRequestOptions - ]; - "GET /repos/:owner/:repo/git/trees/:tree_sha": [ - GitGetTreeEndpoint, - GitGetTreeRequestOptions - ]; - "GET /repos/:owner/:repo/hooks": [ - ReposListHooksEndpoint, - ReposListHooksRequestOptions - ]; - "GET /repos/:owner/:repo/hooks/:hook_id": [ - ReposGetHookEndpoint, - ReposGetHookRequestOptions - ]; - "GET /repos/:owner/:repo/import": [ - MigrationsGetImportProgressEndpoint, - MigrationsGetImportProgressRequestOptions - ]; - "GET /repos/:owner/:repo/import/authors": [ - MigrationsGetCommitAuthorsEndpoint, - MigrationsGetCommitAuthorsRequestOptions - ]; - "GET /repos/:owner/:repo/import/large_files": [ - MigrationsGetLargeFilesEndpoint, - MigrationsGetLargeFilesRequestOptions - ]; - "GET /repos/:owner/:repo/installation": [ - AppsGetRepoInstallationEndpoint | AppsFindRepoInstallationEndpoint, - - | AppsGetRepoInstallationRequestOptions - | AppsFindRepoInstallationRequestOptions - ]; - "GET /repos/:owner/:repo/interaction-limits": [ - InteractionsGetRestrictionsForRepoEndpoint, - InteractionsGetRestrictionsForRepoRequestOptions - ]; - "GET /repos/:owner/:repo/invitations": [ - ReposListInvitationsEndpoint, - ReposListInvitationsRequestOptions - ]; - "GET /repos/:owner/:repo/issues": [ - IssuesListForRepoEndpoint, - IssuesListForRepoRequestOptions - ]; - "GET /repos/:owner/:repo/issues/:issue_number": [ - IssuesGetEndpoint, - IssuesGetRequestOptions - ]; - "GET /repos/:owner/:repo/issues/:issue_number/comments": [ - IssuesListCommentsEndpoint, - IssuesListCommentsRequestOptions - ]; - "GET /repos/:owner/:repo/issues/:issue_number/events": [ - IssuesListEventsEndpoint, - IssuesListEventsRequestOptions - ]; - "GET /repos/:owner/:repo/issues/:issue_number/labels": [ - IssuesListLabelsOnIssueEndpoint, - IssuesListLabelsOnIssueRequestOptions - ]; - "GET /repos/:owner/:repo/issues/:issue_number/reactions": [ - ReactionsListForIssueEndpoint, - ReactionsListForIssueRequestOptions - ]; - "GET /repos/:owner/:repo/issues/:issue_number/timeline": [ - IssuesListEventsForTimelineEndpoint, - IssuesListEventsForTimelineRequestOptions - ]; - "GET /repos/:owner/:repo/issues/comments": [ - IssuesListCommentsForRepoEndpoint, - IssuesListCommentsForRepoRequestOptions - ]; - "GET /repos/:owner/:repo/issues/comments/:comment_id": [ - IssuesGetCommentEndpoint, - IssuesGetCommentRequestOptions - ]; - "GET /repos/:owner/:repo/issues/comments/:comment_id/reactions": [ - ReactionsListForIssueCommentEndpoint, - ReactionsListForIssueCommentRequestOptions - ]; - "GET /repos/:owner/:repo/issues/events": [ - IssuesListEventsForRepoEndpoint, - IssuesListEventsForRepoRequestOptions - ]; - "GET /repos/:owner/:repo/issues/events/:event_id": [ - IssuesGetEventEndpoint, - IssuesGetEventRequestOptions - ]; - "GET /repos/:owner/:repo/keys": [ - ReposListDeployKeysEndpoint, - ReposListDeployKeysRequestOptions - ]; - "GET /repos/:owner/:repo/keys/:key_id": [ - ReposGetDeployKeyEndpoint, - ReposGetDeployKeyRequestOptions - ]; - "GET /repos/:owner/:repo/labels": [ - IssuesListLabelsForRepoEndpoint, - IssuesListLabelsForRepoRequestOptions - ]; - "GET /repos/:owner/:repo/labels/:name": [ - IssuesGetLabelEndpoint, - IssuesGetLabelRequestOptions - ]; - "GET /repos/:owner/:repo/languages": [ - ReposListLanguagesEndpoint, - ReposListLanguagesRequestOptions - ]; - "GET /repos/:owner/:repo/license": [ - LicensesGetForRepoEndpoint, - LicensesGetForRepoRequestOptions - ]; - "GET /repos/:owner/:repo/milestones": [ - IssuesListMilestonesForRepoEndpoint, - IssuesListMilestonesForRepoRequestOptions - ]; - "GET /repos/:owner/:repo/milestones/:milestone_number": [ - IssuesGetMilestoneEndpoint, - IssuesGetMilestoneRequestOptions - ]; - "GET /repos/:owner/:repo/milestones/:milestone_number/labels": [ - IssuesListLabelsForMilestoneEndpoint, - IssuesListLabelsForMilestoneRequestOptions - ]; - "GET /repos/:owner/:repo/notifications": [ - ActivityListNotificationsForRepoEndpoint, - ActivityListNotificationsForRepoRequestOptions - ]; - "GET /repos/:owner/:repo/pages": [ - ReposGetPagesEndpoint, - ReposGetPagesRequestOptions - ]; - "GET /repos/:owner/:repo/pages/builds": [ - ReposListPagesBuildsEndpoint, - ReposListPagesBuildsRequestOptions - ]; - "GET /repos/:owner/:repo/pages/builds/:build_id": [ - ReposGetPagesBuildEndpoint, - ReposGetPagesBuildRequestOptions - ]; - "GET /repos/:owner/:repo/pages/builds/latest": [ - ReposGetLatestPagesBuildEndpoint, - ReposGetLatestPagesBuildRequestOptions - ]; - "GET /repos/:owner/:repo/projects": [ - ProjectsListForRepoEndpoint, - ProjectsListForRepoRequestOptions - ]; - "GET /repos/:owner/:repo/pulls": [PullsListEndpoint, PullsListRequestOptions]; - "GET /repos/:owner/:repo/pulls/:pull_number": [ - PullsGetEndpoint, - PullsGetRequestOptions - ]; - "GET /repos/:owner/:repo/pulls/:pull_number/comments": [ - PullsListCommentsEndpoint, - PullsListCommentsRequestOptions - ]; - "GET /repos/:owner/:repo/pulls/:pull_number/commits": [ - PullsListCommitsEndpoint, - PullsListCommitsRequestOptions - ]; - "GET /repos/:owner/:repo/pulls/:pull_number/files": [ - PullsListFilesEndpoint, - PullsListFilesRequestOptions - ]; - "GET /repos/:owner/:repo/pulls/:pull_number/merge": [ - PullsCheckIfMergedEndpoint, - PullsCheckIfMergedRequestOptions - ]; - "GET /repos/:owner/:repo/pulls/:pull_number/requested_reviewers": [ - PullsListReviewRequestsEndpoint, - PullsListReviewRequestsRequestOptions - ]; - "GET /repos/:owner/:repo/pulls/:pull_number/reviews": [ - PullsListReviewsEndpoint, - PullsListReviewsRequestOptions - ]; - "GET /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id": [ - PullsGetReviewEndpoint, - PullsGetReviewRequestOptions - ]; - "GET /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/comments": [ - PullsGetCommentsForReviewEndpoint, - PullsGetCommentsForReviewRequestOptions - ]; - "GET /repos/:owner/:repo/pulls/comments": [ - PullsListCommentsForRepoEndpoint, - PullsListCommentsForRepoRequestOptions - ]; - "GET /repos/:owner/:repo/pulls/comments/:comment_id": [ - PullsGetCommentEndpoint, - PullsGetCommentRequestOptions - ]; - "GET /repos/:owner/:repo/pulls/comments/:comment_id/reactions": [ - ReactionsListForPullRequestReviewCommentEndpoint, - ReactionsListForPullRequestReviewCommentRequestOptions - ]; - "GET /repos/:owner/:repo/readme": [ - ReposGetReadmeEndpoint, - ReposGetReadmeRequestOptions - ]; - "GET /repos/:owner/:repo/releases": [ - ReposListReleasesEndpoint, - ReposListReleasesRequestOptions - ]; - "GET /repos/:owner/:repo/releases/:release_id": [ - ReposGetReleaseEndpoint, - ReposGetReleaseRequestOptions - ]; - "GET /repos/:owner/:repo/releases/:release_id/assets": [ - ReposListAssetsForReleaseEndpoint, - ReposListAssetsForReleaseRequestOptions - ]; - "GET /repos/:owner/:repo/releases/assets/:asset_id": [ - ReposGetReleaseAssetEndpoint, - ReposGetReleaseAssetRequestOptions - ]; - "GET /repos/:owner/:repo/releases/latest": [ - ReposGetLatestReleaseEndpoint, - ReposGetLatestReleaseRequestOptions - ]; - "GET /repos/:owner/:repo/releases/tags/:tag": [ - ReposGetReleaseByTagEndpoint, - ReposGetReleaseByTagRequestOptions - ]; - "GET /repos/:owner/:repo/stargazers": [ - ActivityListStargazersForRepoEndpoint, - ActivityListStargazersForRepoRequestOptions - ]; - "GET /repos/:owner/:repo/stats/code_frequency": [ - ReposGetCodeFrequencyStatsEndpoint, - ReposGetCodeFrequencyStatsRequestOptions - ]; - "GET /repos/:owner/:repo/stats/commit_activity": [ - ReposGetCommitActivityStatsEndpoint, - ReposGetCommitActivityStatsRequestOptions - ]; - "GET /repos/:owner/:repo/stats/contributors": [ - ReposGetContributorsStatsEndpoint, - ReposGetContributorsStatsRequestOptions - ]; - "GET /repos/:owner/:repo/stats/participation": [ - ReposGetParticipationStatsEndpoint, - ReposGetParticipationStatsRequestOptions - ]; - "GET /repos/:owner/:repo/stats/punch_card": [ - ReposGetPunchCardStatsEndpoint, - ReposGetPunchCardStatsRequestOptions - ]; - "GET /repos/:owner/:repo/subscribers": [ - ActivityListWatchersForRepoEndpoint, - ActivityListWatchersForRepoRequestOptions - ]; - "GET /repos/:owner/:repo/subscription": [ - ActivityGetRepoSubscriptionEndpoint, - ActivityGetRepoSubscriptionRequestOptions - ]; - "GET /repos/:owner/:repo/tags": [ - ReposListTagsEndpoint, - ReposListTagsRequestOptions - ]; - "GET /repos/:owner/:repo/teams": [ - ReposListTeamsEndpoint, - ReposListTeamsRequestOptions - ]; - "GET /repos/:owner/:repo/topics": [ - ReposListTopicsEndpoint, - ReposListTopicsRequestOptions - ]; - "GET /repos/:owner/:repo/traffic/clones": [ - ReposGetClonesEndpoint, - ReposGetClonesRequestOptions - ]; - "GET /repos/:owner/:repo/traffic/popular/paths": [ - ReposGetTopPathsEndpoint, - ReposGetTopPathsRequestOptions - ]; - "GET /repos/:owner/:repo/traffic/popular/referrers": [ - ReposGetTopReferrersEndpoint, - ReposGetTopReferrersRequestOptions - ]; - "GET /repos/:owner/:repo/traffic/views": [ - ReposGetViewsEndpoint, - ReposGetViewsRequestOptions - ]; - "GET /repos/:owner/:repo/vulnerability-alerts": [ - ReposCheckVulnerabilityAlertsEndpoint, - ReposCheckVulnerabilityAlertsRequestOptions - ]; - "GET /repositories": [ReposListPublicEndpoint, ReposListPublicRequestOptions]; - "GET /scim/v2/organizations/:org/Users": [ - ScimListProvisionedIdentitiesEndpoint, - ScimListProvisionedIdentitiesRequestOptions - ]; - "GET /scim/v2/organizations/:org/Users/:scim_user_id": [ - ScimGetProvisioningDetailsForUserEndpoint, - ScimGetProvisioningDetailsForUserRequestOptions - ]; - "GET /search/code": [SearchCodeEndpoint, SearchCodeRequestOptions]; - "GET /search/commits": [SearchCommitsEndpoint, SearchCommitsRequestOptions]; - "GET /search/issues": [ - SearchIssuesAndPullRequestsEndpoint | SearchIssuesEndpoint, - SearchIssuesAndPullRequestsRequestOptions | SearchIssuesRequestOptions - ]; - "GET /search/labels": [SearchLabelsEndpoint, SearchLabelsRequestOptions]; - "GET /search/repositories": [SearchReposEndpoint, SearchReposRequestOptions]; - "GET /search/topics": [SearchTopicsEndpoint, SearchTopicsRequestOptions]; - "GET /search/users": [SearchUsersEndpoint, SearchUsersRequestOptions]; - "GET /teams/:team_id": [TeamsGetEndpoint, TeamsGetRequestOptions]; - "GET /teams/:team_id/discussions": [ - TeamsListDiscussionsEndpoint, - TeamsListDiscussionsRequestOptions - ]; - "GET /teams/:team_id/discussions/:discussion_number": [ - TeamsGetDiscussionEndpoint, - TeamsGetDiscussionRequestOptions - ]; - "GET /teams/:team_id/discussions/:discussion_number/comments": [ - TeamsListDiscussionCommentsEndpoint, - TeamsListDiscussionCommentsRequestOptions - ]; - "GET /teams/:team_id/discussions/:discussion_number/comments/:comment_number": [ - TeamsGetDiscussionCommentEndpoint, - TeamsGetDiscussionCommentRequestOptions - ]; - "GET /teams/:team_id/discussions/:discussion_number/comments/:comment_number/reactions": [ - ReactionsListForTeamDiscussionCommentEndpoint, - ReactionsListForTeamDiscussionCommentRequestOptions - ]; - "GET /teams/:team_id/discussions/:discussion_number/reactions": [ - ReactionsListForTeamDiscussionEndpoint, - ReactionsListForTeamDiscussionRequestOptions - ]; - "GET /teams/:team_id/invitations": [ - TeamsListPendingInvitationsEndpoint, - TeamsListPendingInvitationsRequestOptions - ]; - "GET /teams/:team_id/members": [ - TeamsListMembersEndpoint, - TeamsListMembersRequestOptions - ]; - "GET /teams/:team_id/members/:username": [ - TeamsGetMemberEndpoint, - TeamsGetMemberRequestOptions - ]; - "GET /teams/:team_id/memberships/:username": [ - TeamsGetMembershipEndpoint, - TeamsGetMembershipRequestOptions - ]; - "GET /teams/:team_id/projects": [ - TeamsListProjectsEndpoint, - TeamsListProjectsRequestOptions - ]; - "GET /teams/:team_id/projects/:project_id": [ - TeamsReviewProjectEndpoint, - TeamsReviewProjectRequestOptions - ]; - "GET /teams/:team_id/repos": [ - TeamsListReposEndpoint, - TeamsListReposRequestOptions - ]; - "GET /teams/:team_id/repos/:owner/:repo": [ - TeamsCheckManagesRepoEndpoint, - TeamsCheckManagesRepoRequestOptions - ]; - "GET /teams/:team_id/team-sync/group-mappings": [ - TeamsListIdPGroupsEndpoint, - TeamsListIdPGroupsRequestOptions - ]; - "GET /teams/:team_id/teams": [ - TeamsListChildEndpoint, - TeamsListChildRequestOptions - ]; - "GET /user": [ - UsersGetAuthenticatedEndpoint, - UsersGetAuthenticatedRequestOptions - ]; - "GET /user/blocks": [ - UsersListBlockedEndpoint, - UsersListBlockedRequestOptions - ]; - "GET /user/blocks/:username": [ - UsersCheckBlockedEndpoint, - UsersCheckBlockedRequestOptions - ]; - "GET /user/emails": [UsersListEmailsEndpoint, UsersListEmailsRequestOptions]; - "GET /user/followers": [ - UsersListFollowersForAuthenticatedUserEndpoint, - UsersListFollowersForAuthenticatedUserRequestOptions - ]; - "GET /user/following": [ - UsersListFollowingForAuthenticatedUserEndpoint, - UsersListFollowingForAuthenticatedUserRequestOptions - ]; - "GET /user/following/:username": [ - UsersCheckFollowingEndpoint, - UsersCheckFollowingRequestOptions - ]; - "GET /user/gpg_keys": [ - UsersListGpgKeysEndpoint, - UsersListGpgKeysRequestOptions - ]; - "GET /user/gpg_keys/:gpg_key_id": [ - UsersGetGpgKeyEndpoint, - UsersGetGpgKeyRequestOptions - ]; - "GET /user/installations": [ - AppsListInstallationsForAuthenticatedUserEndpoint, - AppsListInstallationsForAuthenticatedUserRequestOptions - ]; - "GET /user/installations/:installation_id/repositories": [ - AppsListInstallationReposForAuthenticatedUserEndpoint, - AppsListInstallationReposForAuthenticatedUserRequestOptions - ]; - "GET /user/issues": [ - IssuesListForAuthenticatedUserEndpoint, - IssuesListForAuthenticatedUserRequestOptions - ]; - "GET /user/keys": [ - UsersListPublicKeysEndpoint, - UsersListPublicKeysRequestOptions - ]; - "GET /user/keys/:key_id": [ - UsersGetPublicKeyEndpoint, - UsersGetPublicKeyRequestOptions - ]; - "GET /user/marketplace_purchases": [ - AppsListMarketplacePurchasesForAuthenticatedUserEndpoint, - AppsListMarketplacePurchasesForAuthenticatedUserRequestOptions - ]; - "GET /user/marketplace_purchases/stubbed": [ - AppsListMarketplacePurchasesForAuthenticatedUserStubbedEndpoint, - AppsListMarketplacePurchasesForAuthenticatedUserStubbedRequestOptions - ]; - "GET /user/memberships/orgs": [ - OrgsListMembershipsEndpoint, - OrgsListMembershipsRequestOptions - ]; - "GET /user/memberships/orgs/:org": [ - OrgsGetMembershipForAuthenticatedUserEndpoint, - OrgsGetMembershipForAuthenticatedUserRequestOptions - ]; - "GET /user/migrations": [ - MigrationsListForAuthenticatedUserEndpoint, - MigrationsListForAuthenticatedUserRequestOptions - ]; - "GET /user/migrations/:migration_id": [ - MigrationsGetStatusForAuthenticatedUserEndpoint, - MigrationsGetStatusForAuthenticatedUserRequestOptions - ]; - "GET /user/migrations/:migration_id/archive": [ - MigrationsGetArchiveForAuthenticatedUserEndpoint, - MigrationsGetArchiveForAuthenticatedUserRequestOptions - ]; - "GET /user/orgs": [ - OrgsListForAuthenticatedUserEndpoint, - OrgsListForAuthenticatedUserRequestOptions - ]; - "GET /user/public_emails": [ - UsersListPublicEmailsEndpoint, - UsersListPublicEmailsRequestOptions - ]; - "GET /user/repos": [ReposListEndpoint, ReposListRequestOptions]; - "GET /user/repository_invitations": [ - ReposListInvitationsForAuthenticatedUserEndpoint, - ReposListInvitationsForAuthenticatedUserRequestOptions - ]; - "GET /user/starred": [ - ActivityListReposStarredByAuthenticatedUserEndpoint, - ActivityListReposStarredByAuthenticatedUserRequestOptions - ]; - "GET /user/starred/:owner/:repo": [ - ActivityCheckStarringRepoEndpoint, - ActivityCheckStarringRepoRequestOptions - ]; - "GET /user/subscriptions": [ - ActivityListWatchedReposForAuthenticatedUserEndpoint, - ActivityListWatchedReposForAuthenticatedUserRequestOptions - ]; - "GET /user/subscriptions/:owner/:repo": [ - ActivityCheckWatchingRepoLegacyEndpoint, - ActivityCheckWatchingRepoLegacyRequestOptions - ]; - "GET /user/teams": [ - TeamsListForAuthenticatedUserEndpoint, - TeamsListForAuthenticatedUserRequestOptions - ]; - "GET /users": [UsersListEndpoint, UsersListRequestOptions]; - "GET /users/:username": [ - UsersGetByUsernameEndpoint, - UsersGetByUsernameRequestOptions - ]; - "GET /users/:username/events": [ - ActivityListEventsForUserEndpoint, - ActivityListEventsForUserRequestOptions - ]; - "GET /users/:username/events/orgs/:org": [ - ActivityListEventsForOrgEndpoint, - ActivityListEventsForOrgRequestOptions - ]; - "GET /users/:username/events/public": [ - ActivityListPublicEventsForUserEndpoint, - ActivityListPublicEventsForUserRequestOptions - ]; - "GET /users/:username/followers": [ - UsersListFollowersForUserEndpoint, - UsersListFollowersForUserRequestOptions - ]; - "GET /users/:username/following": [ - UsersListFollowingForUserEndpoint, - UsersListFollowingForUserRequestOptions - ]; - "GET /users/:username/following/:target_user": [ - UsersCheckFollowingForUserEndpoint, - UsersCheckFollowingForUserRequestOptions - ]; - "GET /users/:username/gists": [ - GistsListPublicForUserEndpoint, - GistsListPublicForUserRequestOptions - ]; - "GET /users/:username/gpg_keys": [ - UsersListGpgKeysForUserEndpoint, - UsersListGpgKeysForUserRequestOptions - ]; - "GET /users/:username/hovercard": [ - UsersGetContextForUserEndpoint, - UsersGetContextForUserRequestOptions - ]; - "GET /users/:username/installation": [ - AppsGetUserInstallationEndpoint | AppsFindUserInstallationEndpoint, - - | AppsGetUserInstallationRequestOptions - | AppsFindUserInstallationRequestOptions - ]; - "GET /users/:username/keys": [ - UsersListPublicKeysForUserEndpoint, - UsersListPublicKeysForUserRequestOptions - ]; - "GET /users/:username/orgs": [ - OrgsListForUserEndpoint, - OrgsListForUserRequestOptions - ]; - "GET /users/:username/projects": [ - ProjectsListForUserEndpoint, - ProjectsListForUserRequestOptions - ]; - "GET /users/:username/received_events": [ - ActivityListReceivedEventsForUserEndpoint, - ActivityListReceivedEventsForUserRequestOptions - ]; - "GET /users/:username/received_events/public": [ - ActivityListReceivedPublicEventsForUserEndpoint, - ActivityListReceivedPublicEventsForUserRequestOptions - ]; - "GET /users/:username/repos": [ - ReposListForUserEndpoint, - ReposListForUserRequestOptions - ]; - "GET /users/:username/starred": [ - ActivityListReposStarredByUserEndpoint, - ActivityListReposStarredByUserRequestOptions - ]; - "GET /users/:username/subscriptions": [ - ActivityListReposWatchedByUserEndpoint, - ActivityListReposWatchedByUserRequestOptions - ]; - "PATCH /authorizations/:authorization_id": [ - OauthAuthorizationsUpdateAuthorizationEndpoint, - OauthAuthorizationsUpdateAuthorizationRequestOptions - ]; - "PATCH /gists/:gist_id": [GistsUpdateEndpoint, GistsUpdateRequestOptions]; - "PATCH /gists/:gist_id/comments/:comment_id": [ - GistsUpdateCommentEndpoint, - GistsUpdateCommentRequestOptions - ]; - "PATCH /notifications/threads/:thread_id": [ - ActivityMarkThreadAsReadEndpoint, - ActivityMarkThreadAsReadRequestOptions - ]; - "PATCH /orgs/:org": [OrgsUpdateEndpoint, OrgsUpdateRequestOptions]; - "PATCH /orgs/:org/hooks/:hook_id": [ - OrgsUpdateHookEndpoint, - OrgsUpdateHookRequestOptions - ]; - "PATCH /projects/:project_id": [ - ProjectsUpdateEndpoint, - ProjectsUpdateRequestOptions - ]; - "PATCH /projects/columns/:column_id": [ - ProjectsUpdateColumnEndpoint, - ProjectsUpdateColumnRequestOptions - ]; - "PATCH /projects/columns/cards/:card_id": [ - ProjectsUpdateCardEndpoint, - ProjectsUpdateCardRequestOptions - ]; - "PATCH /repos/:owner/:repo": [ReposUpdateEndpoint, ReposUpdateRequestOptions]; - "PATCH /repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews": [ - ReposUpdateProtectedBranchPullRequestReviewEnforcementEndpoint, - ReposUpdateProtectedBranchPullRequestReviewEnforcementRequestOptions - ]; - "PATCH /repos/:owner/:repo/branches/:branch/protection/required_status_checks": [ - ReposUpdateProtectedBranchRequiredStatusChecksEndpoint, - ReposUpdateProtectedBranchRequiredStatusChecksRequestOptions - ]; - "PATCH /repos/:owner/:repo/check-runs/:check_run_id": [ - ChecksUpdateEndpoint, - ChecksUpdateRequestOptions - ]; - "PATCH /repos/:owner/:repo/check-suites/preferences": [ - ChecksSetSuitesPreferencesEndpoint, - ChecksSetSuitesPreferencesRequestOptions - ]; - "PATCH /repos/:owner/:repo/comments/:comment_id": [ - ReposUpdateCommitCommentEndpoint, - ReposUpdateCommitCommentRequestOptions - ]; - "PATCH /repos/:owner/:repo/git/refs/:ref": [ - GitUpdateRefEndpoint, - GitUpdateRefRequestOptions - ]; - "PATCH /repos/:owner/:repo/hooks/:hook_id": [ - ReposUpdateHookEndpoint, - ReposUpdateHookRequestOptions - ]; - "PATCH /repos/:owner/:repo/import": [ - MigrationsUpdateImportEndpoint, - MigrationsUpdateImportRequestOptions - ]; - "PATCH /repos/:owner/:repo/import/authors/:author_id": [ - MigrationsMapCommitAuthorEndpoint, - MigrationsMapCommitAuthorRequestOptions - ]; - "PATCH /repos/:owner/:repo/import/lfs": [ - MigrationsSetLfsPreferenceEndpoint, - MigrationsSetLfsPreferenceRequestOptions - ]; - "PATCH /repos/:owner/:repo/invitations/:invitation_id": [ - ReposUpdateInvitationEndpoint, - ReposUpdateInvitationRequestOptions - ]; - "PATCH /repos/:owner/:repo/issues/:issue_number": [ - IssuesUpdateEndpoint, - IssuesUpdateRequestOptions - ]; - "PATCH /repos/:owner/:repo/issues/comments/:comment_id": [ - IssuesUpdateCommentEndpoint, - IssuesUpdateCommentRequestOptions - ]; - "PATCH /repos/:owner/:repo/labels/:name": [ - IssuesUpdateLabelEndpoint, - IssuesUpdateLabelRequestOptions - ]; - "PATCH /repos/:owner/:repo/milestones/:milestone_number": [ - IssuesUpdateMilestoneEndpoint, - IssuesUpdateMilestoneRequestOptions - ]; - "PATCH /repos/:owner/:repo/pulls/:pull_number": [ - PullsUpdateEndpoint, - PullsUpdateRequestOptions - ]; - "PATCH /repos/:owner/:repo/pulls/comments/:comment_id": [ - PullsUpdateCommentEndpoint, - PullsUpdateCommentRequestOptions - ]; - "PATCH /repos/:owner/:repo/releases/:release_id": [ - ReposUpdateReleaseEndpoint, - ReposUpdateReleaseRequestOptions - ]; - "PATCH /repos/:owner/:repo/releases/assets/:asset_id": [ - ReposUpdateReleaseAssetEndpoint, - ReposUpdateReleaseAssetRequestOptions - ]; - "PATCH /scim/v2/organizations/:org/Users/:scim_user_id": [ - ScimUpdateUserAttributeEndpoint, - ScimUpdateUserAttributeRequestOptions - ]; - "PATCH /teams/:team_id": [TeamsUpdateEndpoint, TeamsUpdateRequestOptions]; - "PATCH /teams/:team_id/discussions/:discussion_number": [ - TeamsUpdateDiscussionEndpoint, - TeamsUpdateDiscussionRequestOptions - ]; - "PATCH /teams/:team_id/discussions/:discussion_number/comments/:comment_number": [ - TeamsUpdateDiscussionCommentEndpoint, - TeamsUpdateDiscussionCommentRequestOptions - ]; - "PATCH /teams/:team_id/team-sync/group-mappings": [ - TeamsCreateOrUpdateIdPGroupConnectionsEndpoint, - TeamsCreateOrUpdateIdPGroupConnectionsRequestOptions - ]; - "PATCH /user": [ - UsersUpdateAuthenticatedEndpoint, - UsersUpdateAuthenticatedRequestOptions - ]; - "PATCH /user/email/visibility": [ - UsersTogglePrimaryEmailVisibilityEndpoint, - UsersTogglePrimaryEmailVisibilityRequestOptions - ]; - "PATCH /user/memberships/orgs/:org": [ - OrgsUpdateMembershipEndpoint, - OrgsUpdateMembershipRequestOptions - ]; - "PATCH /user/repository_invitations/:invitation_id": [ - ReposAcceptInvitationEndpoint, - ReposAcceptInvitationRequestOptions - ]; - "POST /app-manifests/:code/conversions": [ - AppsCreateFromManifestEndpoint, - AppsCreateFromManifestRequestOptions - ]; - "POST /app/installations/:installation_id/access_tokens": [ - AppsCreateInstallationTokenEndpoint, - AppsCreateInstallationTokenRequestOptions - ]; - "POST /applications/:client_id/tokens/:access_token": [ - OauthAuthorizationsResetAuthorizationEndpoint, - OauthAuthorizationsResetAuthorizationRequestOptions - ]; - "POST /authorizations": [ - OauthAuthorizationsCreateAuthorizationEndpoint, - OauthAuthorizationsCreateAuthorizationRequestOptions - ]; - "POST /content_references/:content_reference_id/attachments": [ - AppsCreateContentAttachmentEndpoint, - AppsCreateContentAttachmentRequestOptions - ]; - "POST /gists": [GistsCreateEndpoint, GistsCreateRequestOptions]; - "POST /gists/:gist_id/comments": [ - GistsCreateCommentEndpoint, - GistsCreateCommentRequestOptions - ]; - "POST /gists/:gist_id/forks": [GistsForkEndpoint, GistsForkRequestOptions]; - "POST /markdown": [MarkdownRenderEndpoint, MarkdownRenderRequestOptions]; - "POST /markdown/raw": [ - MarkdownRenderRawEndpoint, - MarkdownRenderRawRequestOptions - ]; - "POST /orgs/:org/hooks": [ - OrgsCreateHookEndpoint, - OrgsCreateHookRequestOptions - ]; - "POST /orgs/:org/hooks/:hook_id/pings": [ - OrgsPingHookEndpoint, - OrgsPingHookRequestOptions - ]; - "POST /orgs/:org/invitations": [ - OrgsCreateInvitationEndpoint, - OrgsCreateInvitationRequestOptions - ]; - "POST /orgs/:org/migrations": [ - MigrationsStartForOrgEndpoint, - MigrationsStartForOrgRequestOptions - ]; - "POST /orgs/:org/projects": [ - ProjectsCreateForOrgEndpoint, - ProjectsCreateForOrgRequestOptions - ]; - "POST /orgs/:org/repos": [ - ReposCreateInOrgEndpoint, - ReposCreateInOrgRequestOptions - ]; - "POST /orgs/:org/teams": [TeamsCreateEndpoint, TeamsCreateRequestOptions]; - "POST /projects/:project_id/columns": [ - ProjectsCreateColumnEndpoint, - ProjectsCreateColumnRequestOptions - ]; - "POST /projects/columns/:column_id/cards": [ - ProjectsCreateCardEndpoint, - ProjectsCreateCardRequestOptions - ]; - "POST /projects/columns/:column_id/moves": [ - ProjectsMoveColumnEndpoint, - ProjectsMoveColumnRequestOptions - ]; - "POST /projects/columns/cards/:card_id/moves": [ - ProjectsMoveCardEndpoint, - ProjectsMoveCardRequestOptions - ]; - "POST /repos/:owner/:repo/branches/:branch/protection/enforce_admins": [ - ReposAddProtectedBranchAdminEnforcementEndpoint, - ReposAddProtectedBranchAdminEnforcementRequestOptions - ]; - "POST /repos/:owner/:repo/branches/:branch/protection/required_signatures": [ - ReposAddProtectedBranchRequiredSignaturesEndpoint, - ReposAddProtectedBranchRequiredSignaturesRequestOptions - ]; - "POST /repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts": [ - ReposAddProtectedBranchRequiredStatusChecksContextsEndpoint, - ReposAddProtectedBranchRequiredStatusChecksContextsRequestOptions - ]; - "POST /repos/:owner/:repo/branches/:branch/protection/restrictions/apps": [ - ReposAddProtectedBranchAppRestrictionsEndpoint, - ReposAddProtectedBranchAppRestrictionsRequestOptions - ]; - "POST /repos/:owner/:repo/branches/:branch/protection/restrictions/teams": [ - ReposAddProtectedBranchTeamRestrictionsEndpoint, - ReposAddProtectedBranchTeamRestrictionsRequestOptions - ]; - "POST /repos/:owner/:repo/branches/:branch/protection/restrictions/users": [ - ReposAddProtectedBranchUserRestrictionsEndpoint, - ReposAddProtectedBranchUserRestrictionsRequestOptions - ]; - "POST /repos/:owner/:repo/check-runs": [ - ChecksCreateEndpoint, - ChecksCreateRequestOptions - ]; - "POST /repos/:owner/:repo/check-suites": [ - ChecksCreateSuiteEndpoint, - ChecksCreateSuiteRequestOptions - ]; - "POST /repos/:owner/:repo/check-suites/:check_suite_id/rerequest": [ - ChecksRerequestSuiteEndpoint, - ChecksRerequestSuiteRequestOptions - ]; - "POST /repos/:owner/:repo/comments/:comment_id/reactions": [ - ReactionsCreateForCommitCommentEndpoint, - ReactionsCreateForCommitCommentRequestOptions - ]; - "POST /repos/:owner/:repo/commits/:commit_sha/comments": [ - ReposCreateCommitCommentEndpoint, - ReposCreateCommitCommentRequestOptions - ]; - "POST /repos/:owner/:repo/deployments": [ - ReposCreateDeploymentEndpoint, - ReposCreateDeploymentRequestOptions - ]; - "POST /repos/:owner/:repo/deployments/:deployment_id/statuses": [ - ReposCreateDeploymentStatusEndpoint, - ReposCreateDeploymentStatusRequestOptions - ]; - "POST /repos/:owner/:repo/dispatches": [ - ReposCreateDispatchEventEndpoint, - ReposCreateDispatchEventRequestOptions - ]; - "POST /repos/:owner/:repo/forks": [ - ReposCreateForkEndpoint, - ReposCreateForkRequestOptions - ]; - "POST /repos/:owner/:repo/git/blobs": [ - GitCreateBlobEndpoint, - GitCreateBlobRequestOptions - ]; - "POST /repos/:owner/:repo/git/commits": [ - GitCreateCommitEndpoint, - GitCreateCommitRequestOptions - ]; - "POST /repos/:owner/:repo/git/refs": [ - GitCreateRefEndpoint, - GitCreateRefRequestOptions - ]; - "POST /repos/:owner/:repo/git/tags": [ - GitCreateTagEndpoint, - GitCreateTagRequestOptions - ]; - "POST /repos/:owner/:repo/git/trees": [ - GitCreateTreeEndpoint, - GitCreateTreeRequestOptions - ]; - "POST /repos/:owner/:repo/hooks": [ - ReposCreateHookEndpoint, - ReposCreateHookRequestOptions - ]; - "POST /repos/:owner/:repo/hooks/:hook_id/pings": [ - ReposPingHookEndpoint, - ReposPingHookRequestOptions - ]; - "POST /repos/:owner/:repo/hooks/:hook_id/tests": [ - ReposTestPushHookEndpoint, - ReposTestPushHookRequestOptions - ]; - "POST /repos/:owner/:repo/issues": [ - IssuesCreateEndpoint, - IssuesCreateRequestOptions - ]; - "POST /repos/:owner/:repo/issues/:issue_number/assignees": [ - IssuesAddAssigneesEndpoint, - IssuesAddAssigneesRequestOptions - ]; - "POST /repos/:owner/:repo/issues/:issue_number/comments": [ - IssuesCreateCommentEndpoint, - IssuesCreateCommentRequestOptions - ]; - "POST /repos/:owner/:repo/issues/:issue_number/labels": [ - IssuesAddLabelsEndpoint, - IssuesAddLabelsRequestOptions - ]; - "POST /repos/:owner/:repo/issues/:issue_number/reactions": [ - ReactionsCreateForIssueEndpoint, - ReactionsCreateForIssueRequestOptions - ]; - "POST /repos/:owner/:repo/issues/comments/:comment_id/reactions": [ - ReactionsCreateForIssueCommentEndpoint, - ReactionsCreateForIssueCommentRequestOptions - ]; - "POST /repos/:owner/:repo/keys": [ - ReposAddDeployKeyEndpoint, - ReposAddDeployKeyRequestOptions - ]; - "POST /repos/:owner/:repo/labels": [ - IssuesCreateLabelEndpoint, - IssuesCreateLabelRequestOptions - ]; - "POST /repos/:owner/:repo/merges": [ - ReposMergeEndpoint, - ReposMergeRequestOptions - ]; - "POST /repos/:owner/:repo/milestones": [ - IssuesCreateMilestoneEndpoint, - IssuesCreateMilestoneRequestOptions - ]; - "POST /repos/:owner/:repo/pages": [ - ReposEnablePagesSiteEndpoint, - ReposEnablePagesSiteRequestOptions - ]; - "POST /repos/:owner/:repo/pages/builds": [ - ReposRequestPageBuildEndpoint, - ReposRequestPageBuildRequestOptions - ]; - "POST /repos/:owner/:repo/projects": [ - ProjectsCreateForRepoEndpoint, - ProjectsCreateForRepoRequestOptions - ]; - "POST /repos/:owner/:repo/pulls": [ - PullsCreateEndpoint, - PullsCreateRequestOptions - ]; - "POST /repos/:owner/:repo/pulls/:pull_number/comments": [ - PullsCreateCommentEndpoint | PullsCreateCommentReplyEndpoint, - PullsCreateCommentRequestOptions | PullsCreateCommentReplyRequestOptions - ]; - "POST /repos/:owner/:repo/pulls/:pull_number/comments/:comment_id/replies": [ - PullsCreateReviewCommentReplyEndpoint, - PullsCreateReviewCommentReplyRequestOptions - ]; - "POST /repos/:owner/:repo/pulls/:pull_number/requested_reviewers": [ - PullsCreateReviewRequestEndpoint, - PullsCreateReviewRequestRequestOptions - ]; - "POST /repos/:owner/:repo/pulls/:pull_number/reviews": [ - PullsCreateReviewEndpoint, - PullsCreateReviewRequestOptions - ]; - "POST /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/events": [ - PullsSubmitReviewEndpoint, - PullsSubmitReviewRequestOptions - ]; - "POST /repos/:owner/:repo/pulls/comments/:comment_id/reactions": [ - ReactionsCreateForPullRequestReviewCommentEndpoint, - ReactionsCreateForPullRequestReviewCommentRequestOptions - ]; - "POST /repos/:owner/:repo/releases": [ - ReposCreateReleaseEndpoint, - ReposCreateReleaseRequestOptions - ]; - "POST /repos/:owner/:repo/statuses/:sha": [ - ReposCreateStatusEndpoint, - ReposCreateStatusRequestOptions - ]; - "POST /repos/:owner/:repo/transfer": [ - ReposTransferEndpoint, - ReposTransferRequestOptions - ]; - "POST /repos/:template_owner/:template_repo/generate": [ - ReposCreateUsingTemplateEndpoint, - ReposCreateUsingTemplateRequestOptions - ]; - "POST /scim/v2/organizations/:org/Users": [ - ScimProvisionAndInviteUsersEndpoint | ScimProvisionInviteUsersEndpoint, - - | ScimProvisionAndInviteUsersRequestOptions - | ScimProvisionInviteUsersRequestOptions - ]; - "POST /teams/:team_id/discussions": [ - TeamsCreateDiscussionEndpoint, - TeamsCreateDiscussionRequestOptions - ]; - "POST /teams/:team_id/discussions/:discussion_number/comments": [ - TeamsCreateDiscussionCommentEndpoint, - TeamsCreateDiscussionCommentRequestOptions - ]; - "POST /teams/:team_id/discussions/:discussion_number/comments/:comment_number/reactions": [ - ReactionsCreateForTeamDiscussionCommentEndpoint, - ReactionsCreateForTeamDiscussionCommentRequestOptions - ]; - "POST /teams/:team_id/discussions/:discussion_number/reactions": [ - ReactionsCreateForTeamDiscussionEndpoint, - ReactionsCreateForTeamDiscussionRequestOptions - ]; - "POST /user/emails": [UsersAddEmailsEndpoint, UsersAddEmailsRequestOptions]; - "POST /user/gpg_keys": [ - UsersCreateGpgKeyEndpoint, - UsersCreateGpgKeyRequestOptions - ]; - "POST /user/keys": [ - UsersCreatePublicKeyEndpoint, - UsersCreatePublicKeyRequestOptions - ]; - "POST /user/migrations": [ - MigrationsStartForAuthenticatedUserEndpoint, - MigrationsStartForAuthenticatedUserRequestOptions - ]; - "POST /user/projects": [ - ProjectsCreateForAuthenticatedUserEndpoint, - ProjectsCreateForAuthenticatedUserRequestOptions - ]; - "POST /user/repos": [ - ReposCreateForAuthenticatedUserEndpoint, - ReposCreateForAuthenticatedUserRequestOptions - ]; - "PUT /authorizations/clients/:client_id": [ - OauthAuthorizationsGetOrCreateAuthorizationForAppEndpoint, - OauthAuthorizationsGetOrCreateAuthorizationForAppRequestOptions - ]; - "PUT /authorizations/clients/:client_id/:fingerprint": [ - - | OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintEndpoint - | OauthAuthorizationsGetOrCreateAuthorizationForAppFingerprintEndpoint, - - | OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintRequestOptions - | OauthAuthorizationsGetOrCreateAuthorizationForAppFingerprintRequestOptions - ]; - "PUT /gists/:gist_id/star": [GistsStarEndpoint, GistsStarRequestOptions]; - "PUT /notifications": [ - ActivityMarkAsReadEndpoint, - ActivityMarkAsReadRequestOptions - ]; - "PUT /notifications/threads/:thread_id/subscription": [ - ActivitySetThreadSubscriptionEndpoint, - ActivitySetThreadSubscriptionRequestOptions - ]; - "PUT /orgs/:org/blocks/:username": [ - OrgsBlockUserEndpoint, - OrgsBlockUserRequestOptions - ]; - "PUT /orgs/:org/interaction-limits": [ - InteractionsAddOrUpdateRestrictionsForOrgEndpoint, - InteractionsAddOrUpdateRestrictionsForOrgRequestOptions - ]; - "PUT /orgs/:org/memberships/:username": [ - OrgsAddOrUpdateMembershipEndpoint, - OrgsAddOrUpdateMembershipRequestOptions - ]; - "PUT /orgs/:org/outside_collaborators/:username": [ - OrgsConvertMemberToOutsideCollaboratorEndpoint, - OrgsConvertMemberToOutsideCollaboratorRequestOptions - ]; - "PUT /orgs/:org/public_members/:username": [ - OrgsPublicizeMembershipEndpoint, - OrgsPublicizeMembershipRequestOptions - ]; - "PUT /projects/:project_id/collaborators/:username": [ - ProjectsAddCollaboratorEndpoint, - ProjectsAddCollaboratorRequestOptions - ]; - "PUT /repos/:owner/:repo/automated-security-fixes": [ - ReposEnableAutomatedSecurityFixesEndpoint, - ReposEnableAutomatedSecurityFixesRequestOptions - ]; - "PUT /repos/:owner/:repo/branches/:branch/protection": [ - ReposUpdateBranchProtectionEndpoint, - ReposUpdateBranchProtectionRequestOptions - ]; - "PUT /repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts": [ - ReposReplaceProtectedBranchRequiredStatusChecksContextsEndpoint, - ReposReplaceProtectedBranchRequiredStatusChecksContextsRequestOptions - ]; - "PUT /repos/:owner/:repo/branches/:branch/protection/restrictions/apps": [ - ReposReplaceProtectedBranchAppRestrictionsEndpoint, - ReposReplaceProtectedBranchAppRestrictionsRequestOptions - ]; - "PUT /repos/:owner/:repo/branches/:branch/protection/restrictions/teams": [ - ReposReplaceProtectedBranchTeamRestrictionsEndpoint, - ReposReplaceProtectedBranchTeamRestrictionsRequestOptions - ]; - "PUT /repos/:owner/:repo/branches/:branch/protection/restrictions/users": [ - ReposReplaceProtectedBranchUserRestrictionsEndpoint, - ReposReplaceProtectedBranchUserRestrictionsRequestOptions - ]; - "PUT /repos/:owner/:repo/collaborators/:username": [ - ReposAddCollaboratorEndpoint, - ReposAddCollaboratorRequestOptions - ]; - "PUT /repos/:owner/:repo/contents/:path": [ - - | ReposCreateOrUpdateFileEndpoint - | ReposCreateFileEndpoint - | ReposUpdateFileEndpoint, - - | ReposCreateOrUpdateFileRequestOptions - | ReposCreateFileRequestOptions - | ReposUpdateFileRequestOptions - ]; - "PUT /repos/:owner/:repo/import": [ - MigrationsStartImportEndpoint, - MigrationsStartImportRequestOptions - ]; - "PUT /repos/:owner/:repo/interaction-limits": [ - InteractionsAddOrUpdateRestrictionsForRepoEndpoint, - InteractionsAddOrUpdateRestrictionsForRepoRequestOptions - ]; - "PUT /repos/:owner/:repo/issues/:issue_number/labels": [ - IssuesReplaceLabelsEndpoint, - IssuesReplaceLabelsRequestOptions - ]; - "PUT /repos/:owner/:repo/issues/:issue_number/lock": [ - IssuesLockEndpoint, - IssuesLockRequestOptions - ]; - "PUT /repos/:owner/:repo/notifications": [ - ActivityMarkNotificationsAsReadForRepoEndpoint, - ActivityMarkNotificationsAsReadForRepoRequestOptions - ]; - "PUT /repos/:owner/:repo/pages": [ - ReposUpdateInformationAboutPagesSiteEndpoint, - ReposUpdateInformationAboutPagesSiteRequestOptions - ]; - "PUT /repos/:owner/:repo/pulls/:pull_number/merge": [ - PullsMergeEndpoint, - PullsMergeRequestOptions - ]; - "PUT /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id": [ - PullsUpdateReviewEndpoint, - PullsUpdateReviewRequestOptions - ]; - "PUT /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/dismissals": [ - PullsDismissReviewEndpoint, - PullsDismissReviewRequestOptions - ]; - "PUT /repos/:owner/:repo/pulls/:pull_number/update-branch": [ - PullsUpdateBranchEndpoint, - PullsUpdateBranchRequestOptions - ]; - "PUT /repos/:owner/:repo/subscription": [ - ActivitySetRepoSubscriptionEndpoint, - ActivitySetRepoSubscriptionRequestOptions - ]; - "PUT /repos/:owner/:repo/topics": [ - ReposReplaceTopicsEndpoint, - ReposReplaceTopicsRequestOptions - ]; - "PUT /repos/:owner/:repo/vulnerability-alerts": [ - ReposEnableVulnerabilityAlertsEndpoint, - ReposEnableVulnerabilityAlertsRequestOptions - ]; - "PUT /scim/v2/organizations/:org/Users/:scim_user_id": [ - - | ScimReplaceProvisionedUserInformationEndpoint - | ScimUpdateProvisionedOrgMembershipEndpoint, - - | ScimReplaceProvisionedUserInformationRequestOptions - | ScimUpdateProvisionedOrgMembershipRequestOptions - ]; - "PUT /teams/:team_id/members/:username": [ - TeamsAddMemberEndpoint, - TeamsAddMemberRequestOptions - ]; - "PUT /teams/:team_id/memberships/:username": [ - TeamsAddOrUpdateMembershipEndpoint, - TeamsAddOrUpdateMembershipRequestOptions - ]; - "PUT /teams/:team_id/projects/:project_id": [ - TeamsAddOrUpdateProjectEndpoint, - TeamsAddOrUpdateProjectRequestOptions - ]; - "PUT /teams/:team_id/repos/:owner/:repo": [ - TeamsAddOrUpdateRepoEndpoint, - TeamsAddOrUpdateRepoRequestOptions - ]; - "PUT /user/blocks/:username": [UsersBlockEndpoint, UsersBlockRequestOptions]; - "PUT /user/following/:username": [ - UsersFollowEndpoint, - UsersFollowRequestOptions - ]; - "PUT /user/installations/:installation_id/repositories/:repository_id": [ - AppsAddRepoToInstallationEndpoint, - AppsAddRepoToInstallationRequestOptions - ]; - "PUT /user/starred/:owner/:repo": [ - ActivityStarRepoEndpoint, - ActivityStarRepoRequestOptions - ]; - "PUT /user/subscriptions/:owner/:repo": [ - ActivityWatchRepoLegacyEndpoint, - ActivityWatchRepoLegacyRequestOptions - ]; + /** + * @see https://developer.github.com/v3/apps/#delete-an-installation + */ + "DELETE /app/installations/:installation_id": { + parameters: AppsDeleteInstallationEndpoint; + request: AppsDeleteInstallationRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/#unsuspend-an-installation + */ + "DELETE /app/installations/:installation_id/suspended": { + parameters: AppsUnsuspendInstallationEndpoint; + request: AppsUnsuspendInstallationRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/oauth_applications/#delete-an-app-authorization + */ + "DELETE /applications/:client_id/grant": { + parameters: AppsDeleteAuthorizationEndpoint; + request: AppsDeleteAuthorizationRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/oauth_applications/#revoke-a-grant-for-an-application + */ + "DELETE /applications/:client_id/grants/:access_token": { + parameters: AppsRevokeGrantForApplicationEndpoint; + request: AppsRevokeGrantForApplicationRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/oauth_applications/#delete-an-app-token + */ + "DELETE /applications/:client_id/token": { + parameters: AppsDeleteTokenEndpoint; + request: AppsDeleteTokenRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/oauth_applications/#revoke-an-authorization-for-an-application + */ + "DELETE /applications/:client_id/tokens/:access_token": { + parameters: AppsRevokeAuthorizationForApplicationEndpoint; + request: AppsRevokeAuthorizationForApplicationRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/oauth_authorizations/#delete-a-grant + */ + "DELETE /applications/grants/:grant_id": { + parameters: OauthAuthorizationsDeleteGrantEndpoint; + request: OauthAuthorizationsDeleteGrantRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/oauth_authorizations/#delete-an-authorization + */ + "DELETE /authorizations/:authorization_id": { + parameters: OauthAuthorizationsDeleteAuthorizationEndpoint; + request: OauthAuthorizationsDeleteAuthorizationRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/gists/#delete-a-gist + */ + "DELETE /gists/:gist_id": { + parameters: GistsDeleteEndpoint; + request: GistsDeleteRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/gists/comments/#delete-a-comment + */ + "DELETE /gists/:gist_id/comments/:comment_id": { + parameters: GistsDeleteCommentEndpoint; + request: GistsDeleteCommentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/gists/#unstar-a-gist + */ + "DELETE /gists/:gist_id/star": { + parameters: GistsUnstarEndpoint; + request: GistsUnstarRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/installations/#revoke-an-installation-token + */ + "DELETE /installation/token": { + parameters: AppsRevokeInstallationTokenEndpoint; + request: AppsRevokeInstallationTokenRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/notifications/#delete-a-thread-subscription + */ + "DELETE /notifications/threads/:thread_id/subscription": { + parameters: ActivityDeleteThreadSubscriptionEndpoint; + request: ActivityDeleteThreadSubscriptionRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/self-hosted-runners/#delete-a-self-hosted-runner-from-an-organization + */ + "DELETE /orgs/:org/actions/runners/:runner_id": { + parameters: ActionsDeleteSelfHostedRunnerFromOrgEndpoint; + request: ActionsDeleteSelfHostedRunnerFromOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/blocking/#unblock-a-user + */ + "DELETE /orgs/:org/blocks/:username": { + parameters: OrgsUnblockUserEndpoint; + request: OrgsUnblockUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/#remove-a-credential-authorization-for-an-organization + */ + "DELETE /orgs/:org/credential-authorizations/:credential_id": { + parameters: OrgsRemoveCredentialAuthorizationEndpoint; + request: OrgsRemoveCredentialAuthorizationRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/hooks/#delete-a-hook + */ + "DELETE /orgs/:org/hooks/:hook_id": { + parameters: OrgsDeleteHookEndpoint; + request: OrgsDeleteHookRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/interactions/orgs/#remove-interaction-restrictions-for-an-organization + */ + "DELETE /orgs/:org/interaction-limits": { + parameters: InteractionsRemoveRestrictionsForOrgEndpoint; + request: InteractionsRemoveRestrictionsForOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/members/#remove-a-member + */ + "DELETE /orgs/:org/members/:username": { + parameters: OrgsRemoveMemberEndpoint; + request: OrgsRemoveMemberRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/members/#remove-organization-membership + */ + "DELETE /orgs/:org/memberships/:username": { + parameters: OrgsRemoveMembershipEndpoint; + request: OrgsRemoveMembershipRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/migrations/orgs/#delete-an-organization-migration-archive + */ + "DELETE /orgs/:org/migrations/:migration_id/archive": { + parameters: MigrationsDeleteArchiveForOrgEndpoint; + request: MigrationsDeleteArchiveForOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/migrations/orgs/#unlock-an-organization-repository + */ + "DELETE /orgs/:org/migrations/:migration_id/repos/:repo_name/lock": { + parameters: MigrationsUnlockRepoForOrgEndpoint; + request: MigrationsUnlockRepoForOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/outside_collaborators/#remove-outside-collaborator + */ + "DELETE /orgs/:org/outside_collaborators/:username": { + parameters: OrgsRemoveOutsideCollaboratorEndpoint; + request: OrgsRemoveOutsideCollaboratorRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/members/#conceal-a-users-membership + */ + "DELETE /orgs/:org/public_members/:username": { + parameters: OrgsConcealMembershipEndpoint; + request: OrgsConcealMembershipRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/#delete-team + */ + "DELETE /orgs/:org/teams/:team_slug": { + parameters: TeamsDeleteInOrgEndpoint; + request: TeamsDeleteInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/discussions/#delete-a-discussion + */ + "DELETE /orgs/:org/teams/:team_slug/discussions/:discussion_number": { + parameters: TeamsDeleteDiscussionInOrgEndpoint; + request: TeamsDeleteDiscussionInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/discussion_comments/#delete-a-comment + */ + "DELETE /orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number": { + parameters: TeamsDeleteDiscussionCommentInOrgEndpoint; + request: TeamsDeleteDiscussionCommentInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/reactions/#delete-team-discussion-comment-reaction + */ + "DELETE /orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id": { + parameters: ReactionsDeleteForTeamDiscussionCommentEndpoint; + request: ReactionsDeleteForTeamDiscussionCommentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/reactions/#delete-team-discussion-reaction + */ + "DELETE /orgs/:org/teams/:team_slug/discussions/:discussion_number/reactions/:reaction_id": { + parameters: ReactionsDeleteForTeamDiscussionEndpoint; + request: ReactionsDeleteForTeamDiscussionRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/members/#remove-team-membership + */ + "DELETE /orgs/:org/teams/:team_slug/memberships/:username": { + parameters: TeamsRemoveMembershipInOrgEndpoint; + request: TeamsRemoveMembershipInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/#remove-team-project + */ + "DELETE /orgs/:org/teams/:team_slug/projects/:project_id": { + parameters: TeamsRemoveProjectInOrgEndpoint; + request: TeamsRemoveProjectInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/#remove-team-repository + */ + "DELETE /orgs/:org/teams/:team_slug/repos/:owner/:repo": { + parameters: TeamsRemoveRepoInOrgEndpoint; + request: TeamsRemoveRepoInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/projects/#delete-a-project + */ + "DELETE /projects/:project_id": { + parameters: ProjectsDeleteEndpoint; + request: ProjectsDeleteRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/projects/collaborators/#remove-user-as-a-collaborator + */ + "DELETE /projects/:project_id/collaborators/:username": { + parameters: ProjectsRemoveCollaboratorEndpoint; + request: ProjectsRemoveCollaboratorRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/projects/columns/#delete-a-project-column + */ + "DELETE /projects/columns/:column_id": { + parameters: ProjectsDeleteColumnEndpoint; + request: ProjectsDeleteColumnRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/projects/cards/#delete-a-project-card + */ + "DELETE /projects/columns/cards/:card_id": { + parameters: ProjectsDeleteCardEndpoint; + request: ProjectsDeleteCardRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/reactions/#delete-a-reaction-legacy + */ + "DELETE /reactions/:reaction_id": { + parameters: ReactionsDeleteLegacyEndpoint; + request: ReactionsDeleteLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/#delete-a-repository + */ + "DELETE /repos/:owner/:repo": { + parameters: ReposDeleteEndpoint; + request: ReposDeleteRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/artifacts/#delete-an-artifact + */ + "DELETE /repos/:owner/:repo/actions/artifacts/:artifact_id": { + parameters: ActionsDeleteArtifactEndpoint; + request: ActionsDeleteArtifactRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/self-hosted-runners/#delete-a-self-hosted-runner-from-a-repository + */ + "DELETE /repos/:owner/:repo/actions/runners/:runner_id": { + parameters: ActionsDeleteSelfHostedRunnerFromRepoEndpoint; + request: ActionsDeleteSelfHostedRunnerFromRepoRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/workflow-runs/#delete-workflow-run-logs + */ + "DELETE /repos/:owner/:repo/actions/runs/:run_id/logs": { + parameters: ActionsDeleteWorkflowRunLogsEndpoint; + request: ActionsDeleteWorkflowRunLogsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/secrets/#delete-a-secret-from-a-repository + */ + "DELETE /repos/:owner/:repo/actions/secrets/:name": { + parameters: ActionsDeleteSecretFromRepoEndpoint; + request: ActionsDeleteSecretFromRepoRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/#disable-automated-security-fixes + */ + "DELETE /repos/:owner/:repo/automated-security-fixes": { + parameters: ReposDisableAutomatedSecurityFixesEndpoint; + request: ReposDisableAutomatedSecurityFixesRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#remove-branch-protection + */ + "DELETE /repos/:owner/:repo/branches/:branch/protection": { + parameters: ReposRemoveBranchProtectionEndpoint; + request: ReposRemoveBranchProtectionRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#remove-admin-enforcement-of-protected-branch + */ + "DELETE /repos/:owner/:repo/branches/:branch/protection/enforce_admins": { + parameters: ReposRemoveProtectedBranchAdminEnforcementEndpoint; + request: ReposRemoveProtectedBranchAdminEnforcementRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#remove-pull-request-review-enforcement-of-protected-branch + */ + "DELETE /repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews": { + parameters: ReposRemoveProtectedBranchPullRequestReviewEnforcementEndpoint; + request: ReposRemoveProtectedBranchPullRequestReviewEnforcementRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#remove-required-signatures-of-protected-branch + */ + "DELETE /repos/:owner/:repo/branches/:branch/protection/required_signatures": { + parameters: ReposRemoveProtectedBranchRequiredSignaturesEndpoint; + request: ReposRemoveProtectedBranchRequiredSignaturesRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#remove-required-status-checks-of-protected-branch + */ + "DELETE /repos/:owner/:repo/branches/:branch/protection/required_status_checks": { + parameters: ReposRemoveProtectedBranchRequiredStatusChecksEndpoint; + request: ReposRemoveProtectedBranchRequiredStatusChecksRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#remove-required-status-checks-contexts-of-protected-branch + */ + "DELETE /repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts": { + parameters: ReposRemoveProtectedBranchRequiredStatusChecksContextsEndpoint; + request: ReposRemoveProtectedBranchRequiredStatusChecksContextsRequestOptions; + response: OctokitResponse< + ReposRemoveProtectedBranchRequiredStatusChecksContextsResponseData + >; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#remove-restrictions-of-protected-branch + */ + "DELETE /repos/:owner/:repo/branches/:branch/protection/restrictions": { + parameters: ReposRemoveProtectedBranchRestrictionsEndpoint; + request: ReposRemoveProtectedBranchRestrictionsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#remove-app-restrictions-of-protected-branch + */ + "DELETE /repos/:owner/:repo/branches/:branch/protection/restrictions/apps": { + parameters: ReposRemoveProtectedBranchAppRestrictionsEndpoint; + request: ReposRemoveProtectedBranchAppRestrictionsRequestOptions; + response: OctokitResponse< + ReposRemoveProtectedBranchAppRestrictionsResponseData + >; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#remove-team-restrictions-of-protected-branch + */ + "DELETE /repos/:owner/:repo/branches/:branch/protection/restrictions/teams": { + parameters: ReposRemoveProtectedBranchTeamRestrictionsEndpoint; + request: ReposRemoveProtectedBranchTeamRestrictionsRequestOptions; + response: OctokitResponse< + ReposRemoveProtectedBranchTeamRestrictionsResponseData + >; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#remove-user-restrictions-of-protected-branch + */ + "DELETE /repos/:owner/:repo/branches/:branch/protection/restrictions/users": { + parameters: ReposRemoveProtectedBranchUserRestrictionsEndpoint; + request: ReposRemoveProtectedBranchUserRestrictionsRequestOptions; + response: OctokitResponse< + ReposRemoveProtectedBranchUserRestrictionsResponseData + >; + }; + /** + * @see https://developer.github.com/v3/repos/collaborators/#remove-user-as-a-collaborator + */ + "DELETE /repos/:owner/:repo/collaborators/:username": { + parameters: ReposRemoveCollaboratorEndpoint; + request: ReposRemoveCollaboratorRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/comments/#delete-a-commit-comment + */ + "DELETE /repos/:owner/:repo/comments/:comment_id": { + parameters: ReposDeleteCommitCommentEndpoint; + request: ReposDeleteCommitCommentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/reactions/#delete-a-commit-comment-reaction + */ + "DELETE /repos/:owner/:repo/comments/:comment_id/reactions/:reaction_id": { + parameters: ReactionsDeleteForCommitCommentEndpoint; + request: ReactionsDeleteForCommitCommentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/contents/#delete-a-file + */ + "DELETE /repos/:owner/:repo/contents/:path": { + parameters: ReposDeleteFileEndpoint; + request: ReposDeleteFileRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/deployments/#delete-a-deployment + */ + "DELETE /repos/:owner/:repo/deployments/:deployment_id": { + parameters: ReposDeleteDeploymentEndpoint; + request: ReposDeleteDeploymentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/downloads/#delete-a-download + */ + "DELETE /repos/:owner/:repo/downloads/:download_id": { + parameters: ReposDeleteDownloadEndpoint; + request: ReposDeleteDownloadRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/git/refs/#delete-a-reference + */ + "DELETE /repos/:owner/:repo/git/refs/:ref": { + parameters: GitDeleteRefEndpoint; + request: GitDeleteRefRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/hooks/#delete-a-hook + */ + "DELETE /repos/:owner/:repo/hooks/:hook_id": { + parameters: ReposDeleteHookEndpoint; + request: ReposDeleteHookRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/migrations/source_imports/#cancel-an-import + */ + "DELETE /repos/:owner/:repo/import": { + parameters: MigrationsCancelImportEndpoint; + request: MigrationsCancelImportRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/interactions/repos/#remove-interaction-restrictions-for-a-repository + */ + "DELETE /repos/:owner/:repo/interaction-limits": { + parameters: InteractionsRemoveRestrictionsForRepoEndpoint; + request: InteractionsRemoveRestrictionsForRepoRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/invitations/#delete-a-repository-invitation + */ + "DELETE /repos/:owner/:repo/invitations/:invitation_id": { + parameters: ReposDeleteInvitationEndpoint; + request: ReposDeleteInvitationRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/assignees/#remove-assignees-from-an-issue + */ + "DELETE /repos/:owner/:repo/issues/:issue_number/assignees": { + parameters: IssuesRemoveAssigneesEndpoint; + request: IssuesRemoveAssigneesRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/labels/#remove-all-labels-from-an-issue + */ + "DELETE /repos/:owner/:repo/issues/:issue_number/labels": { + parameters: IssuesRemoveAllLabelsEndpoint; + request: IssuesRemoveAllLabelsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/labels/#remove-a-label-from-an-issue + */ + "DELETE /repos/:owner/:repo/issues/:issue_number/labels/:name": { + parameters: IssuesRemoveLabelEndpoint; + request: IssuesRemoveLabelRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/#unlock-an-issue + */ + "DELETE /repos/:owner/:repo/issues/:issue_number/lock": { + parameters: IssuesUnlockEndpoint; + request: IssuesUnlockRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/reactions/#delete-an-issue-reaction + */ + "DELETE /repos/:owner/:repo/issues/:issue_number/reactions/:reaction_id": { + parameters: ReactionsDeleteForIssueEndpoint; + request: ReactionsDeleteForIssueRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/comments/#delete-a-comment + */ + "DELETE /repos/:owner/:repo/issues/comments/:comment_id": { + parameters: IssuesDeleteCommentEndpoint; + request: IssuesDeleteCommentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/reactions/#delete-an-issue-comment-reaction + */ + "DELETE /repos/:owner/:repo/issues/comments/:comment_id/reactions/:reaction_id": { + parameters: ReactionsDeleteForIssueCommentEndpoint; + request: ReactionsDeleteForIssueCommentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/keys/#remove-a-deploy-key + */ + "DELETE /repos/:owner/:repo/keys/:key_id": { + parameters: ReposRemoveDeployKeyEndpoint; + request: ReposRemoveDeployKeyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/labels/#delete-a-label + */ + "DELETE /repos/:owner/:repo/labels/:name": { + parameters: IssuesDeleteLabelEndpoint; + request: IssuesDeleteLabelRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/milestones/#delete-a-milestone + */ + "DELETE /repos/:owner/:repo/milestones/:milestone_number": { + parameters: IssuesDeleteMilestoneEndpoint; + request: IssuesDeleteMilestoneRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/pages/#disable-a-pages-site + */ + "DELETE /repos/:owner/:repo/pages": { + parameters: ReposDisablePagesSiteEndpoint; + request: ReposDisablePagesSiteRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/pulls/review_requests/#delete-a-review-request + */ + "DELETE /repos/:owner/:repo/pulls/:pull_number/requested_reviewers": { + parameters: PullsDeleteReviewRequestEndpoint; + request: PullsDeleteReviewRequestRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/pulls/reviews/#delete-a-pending-review + */ + "DELETE /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id": { + parameters: PullsDeletePendingReviewEndpoint; + request: PullsDeletePendingReviewRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/pulls/comments/#delete-a-comment + */ + "DELETE /repos/:owner/:repo/pulls/comments/:comment_id": { + parameters: PullsDeleteCommentEndpoint; + request: PullsDeleteCommentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/reactions/#delete-a-pull-request-comment-reaction + */ + "DELETE /repos/:owner/:repo/pulls/comments/:comment_id/reactions/:reaction_id": { + parameters: ReactionsDeleteForPullRequestCommentEndpoint; + request: ReactionsDeleteForPullRequestCommentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/releases/#delete-a-release + */ + "DELETE /repos/:owner/:repo/releases/:release_id": { + parameters: ReposDeleteReleaseEndpoint; + request: ReposDeleteReleaseRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/releases/#delete-a-release-asset + */ + "DELETE /repos/:owner/:repo/releases/assets/:asset_id": { + parameters: ReposDeleteReleaseAssetEndpoint; + request: ReposDeleteReleaseAssetRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/watching/#delete-a-repository-subscription + */ + "DELETE /repos/:owner/:repo/subscription": { + parameters: ActivityDeleteRepoSubscriptionEndpoint; + request: ActivityDeleteRepoSubscriptionRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/#disable-vulnerability-alerts + */ + "DELETE /repos/:owner/:repo/vulnerability-alerts": { + parameters: ReposDisableVulnerabilityAlertsEndpoint; + request: ReposDisableVulnerabilityAlertsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/scim/#remove-a-user-from-the-organization + */ + "DELETE /scim/v2/organizations/:org/Users/:scim_user_id": { + parameters: ScimRemoveUserFromOrgEndpoint; + request: ScimRemoveUserFromOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/#delete-team-legacy + */ + "DELETE /teams/:team_id": { + parameters: TeamsDeleteLegacyEndpoint; + request: TeamsDeleteLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/discussions/#delete-a-discussion-legacy + */ + "DELETE /teams/:team_id/discussions/:discussion_number": { + parameters: TeamsDeleteDiscussionLegacyEndpoint; + request: TeamsDeleteDiscussionLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/discussion_comments/#delete-a-comment-legacy + */ + "DELETE /teams/:team_id/discussions/:discussion_number/comments/:comment_number": { + parameters: TeamsDeleteDiscussionCommentLegacyEndpoint; + request: TeamsDeleteDiscussionCommentLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/members/#remove-team-member-legacy + */ + "DELETE /teams/:team_id/members/:username": { + parameters: TeamsRemoveMemberLegacyEndpoint; + request: TeamsRemoveMemberLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/members/#remove-team-membership-legacy + */ + "DELETE /teams/:team_id/memberships/:username": { + parameters: TeamsRemoveMembershipLegacyEndpoint; + request: TeamsRemoveMembershipLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/#remove-team-project-legacy + */ + "DELETE /teams/:team_id/projects/:project_id": { + parameters: TeamsRemoveProjectLegacyEndpoint; + request: TeamsRemoveProjectLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/#remove-team-repository-legacy + */ + "DELETE /teams/:team_id/repos/:owner/:repo": { + parameters: TeamsRemoveRepoLegacyEndpoint; + request: TeamsRemoveRepoLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/blocking/#unblock-a-user + */ + "DELETE /user/blocks/:username": { + parameters: UsersUnblockEndpoint; + request: UsersUnblockRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/emails/#delete-email-addresses + */ + "DELETE /user/emails": { + parameters: UsersDeleteEmailsEndpoint; + request: UsersDeleteEmailsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/followers/#unfollow-a-user + */ + "DELETE /user/following/:username": { + parameters: UsersUnfollowEndpoint; + request: UsersUnfollowRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/gpg_keys/#delete-a-gpg-key + */ + "DELETE /user/gpg_keys/:gpg_key_id": { + parameters: UsersDeleteGpgKeyEndpoint; + request: UsersDeleteGpgKeyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/installations/#remove-repository-from-installation + */ + "DELETE /user/installations/:installation_id/repositories/:repository_id": { + parameters: AppsRemoveRepoFromInstallationEndpoint; + request: AppsRemoveRepoFromInstallationRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/keys/#delete-a-public-key + */ + "DELETE /user/keys/:key_id": { + parameters: UsersDeletePublicKeyEndpoint; + request: UsersDeletePublicKeyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/migrations/users/#delete-a-user-migration-archive + */ + "DELETE /user/migrations/:migration_id/archive": { + parameters: MigrationsDeleteArchiveForAuthenticatedUserEndpoint; + request: MigrationsDeleteArchiveForAuthenticatedUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/migrations/users/#unlock-a-user-repository + */ + "DELETE /user/migrations/:migration_id/repos/:repo_name/lock": { + parameters: MigrationsUnlockRepoForAuthenticatedUserEndpoint; + request: MigrationsUnlockRepoForAuthenticatedUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/invitations/#decline-a-repository-invitation + */ + "DELETE /user/repository_invitations/:invitation_id": { + parameters: ReposDeclineInvitationEndpoint; + request: ReposDeclineInvitationRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/starring/#unstar-a-repository-for-the-authenticated-user + */ + "DELETE /user/starred/:owner/:repo": { + parameters: ActivityUnstarRepoForAuthenticatedUserEndpoint; + request: ActivityUnstarRepoForAuthenticatedUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/watching/#stop-watching-a-repository-legacy + */ + "DELETE /user/subscriptions/:owner/:repo": { + parameters: ActivityStopWatchingRepoLegacyEndpoint; + request: ActivityStopWatchingRepoLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/#get-the-authenticated-github-app + */ + "GET /app": { + parameters: AppsGetAuthenticatedEndpoint; + request: AppsGetAuthenticatedRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/#list-installations + */ + "GET /app/installations": { + parameters: AppsListInstallationsEndpoint; + request: AppsListInstallationsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/#get-an-installation + */ + "GET /app/installations/:installation_id": { + parameters: AppsGetInstallationEndpoint; + request: AppsGetInstallationRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/oauth_applications/#check-an-authorization + */ + "GET /applications/:client_id/tokens/:access_token": { + parameters: AppsCheckAuthorizationEndpoint; + request: AppsCheckAuthorizationRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/oauth_authorizations/#list-your-grants + */ + "GET /applications/grants": { + parameters: OauthAuthorizationsListGrantsEndpoint; + request: OauthAuthorizationsListGrantsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/oauth_authorizations/#get-a-single-grant + */ + "GET /applications/grants/:grant_id": { + parameters: OauthAuthorizationsGetGrantEndpoint; + request: OauthAuthorizationsGetGrantRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/#get-a-single-github-app + */ + "GET /apps/:app_slug": { + parameters: AppsGetBySlugEndpoint; + request: AppsGetBySlugRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/oauth_authorizations/#list-your-authorizations + */ + "GET /authorizations": { + parameters: OauthAuthorizationsListAuthorizationsEndpoint; + request: OauthAuthorizationsListAuthorizationsRequestOptions; + response: OctokitResponse< + OauthAuthorizationsListAuthorizationsResponseData + >; + }; + /** + * @see https://developer.github.com/v3/oauth_authorizations/#get-a-single-authorization + */ + "GET /authorizations/:authorization_id": { + parameters: OauthAuthorizationsGetAuthorizationEndpoint; + request: OauthAuthorizationsGetAuthorizationRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/codes_of_conduct/#list-all-codes-of-conduct + */ + "GET /codes_of_conduct": { + parameters: CodesOfConductGetAllCodesOfConductEndpoint; + request: CodesOfConductGetAllCodesOfConductRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/codes_of_conduct/#get-an-individual-code-of-conduct + */ + "GET /codes_of_conduct/:key": { + parameters: CodesOfConductGetConductCodeEndpoint; + request: CodesOfConductGetConductCodeRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/emojis/#emojis + */ + "GET /emojis": { + parameters: EmojisGetEndpoint; + request: EmojisGetRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/events/#list-public-events + */ + "GET /events": { + parameters: ActivityListPublicEventsEndpoint; + request: ActivityListPublicEventsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/feeds/#get-feeds + */ + "GET /feeds": { + parameters: ActivityGetFeedsEndpoint; + request: ActivityGetFeedsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/gists/#list-gists-for-the-authenticated-user + */ + "GET /gists": { + parameters: GistsListEndpoint; + request: GistsListRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/gists/#get-a-gist + */ + "GET /gists/:gist_id": { + parameters: GistsGetEndpoint; + request: GistsGetRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/gists/#get-a-specific-revision-of-a-gist + */ + "GET /gists/:gist_id/:sha": { + parameters: GistsGetRevisionEndpoint; + request: GistsGetRevisionRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/gists/comments/#list-comments-on-a-gist + */ + "GET /gists/:gist_id/comments": { + parameters: GistsListCommentsEndpoint; + request: GistsListCommentsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/gists/comments/#get-a-single-comment + */ + "GET /gists/:gist_id/comments/:comment_id": { + parameters: GistsGetCommentEndpoint; + request: GistsGetCommentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/gists/#list-gist-commits + */ + "GET /gists/:gist_id/commits": { + parameters: GistsListCommitsEndpoint; + request: GistsListCommitsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/gists/#list-gist-forks + */ + "GET /gists/:gist_id/forks": { + parameters: GistsListForksEndpoint; + request: GistsListForksRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/gists/#check-if-a-gist-is-starred + */ + "GET /gists/:gist_id/star": { + parameters: GistsCheckIsStarredEndpoint; + request: GistsCheckIsStarredRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/gists/#list-public-gists + */ + "GET /gists/public": { + parameters: GistsListPublicEndpoint; + request: GistsListPublicRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/gists/#list-starred-gists + */ + "GET /gists/starred": { + parameters: GistsListStarredEndpoint; + request: GistsListStarredRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/gitignore/#listing-available-templates + */ + "GET /gitignore/templates": { + parameters: GitignoreListTemplatesEndpoint; + request: GitignoreListTemplatesRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/gitignore/#get-a-single-template + */ + "GET /gitignore/templates/:name": { + parameters: GitignoreGetTemplateEndpoint; + request: GitignoreGetTemplateRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/installations/#list-repositories + */ + "GET /installation/repositories": { + parameters: AppsListReposEndpoint; + request: AppsListReposRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/#list-issues-assigned-to-the-authenticated-user + */ + "GET /issues": { + parameters: IssuesListEndpoint; + request: IssuesListRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/search/legacy/#search-issues + */ + "GET /legacy/issues/search/:owner/:repository/:state/:keyword": { + parameters: SearchIssuesLegacyEndpoint; + request: SearchIssuesLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/search/legacy/#search-repositories + */ + "GET /legacy/repos/search/:keyword": { + parameters: SearchReposLegacyEndpoint; + request: SearchReposLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/search/legacy/#email-search + */ + "GET /legacy/user/email/:email": { + parameters: SearchEmailLegacyEndpoint; + request: SearchEmailLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/search/legacy/#search-users + */ + "GET /legacy/user/search/:keyword": { + parameters: SearchUsersLegacyEndpoint; + request: SearchUsersLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/licenses/#list-commonly-used-licenses + */ + "GET /licenses": { + parameters: LicensesListCommonlyUsedEndpoint; + request: LicensesListCommonlyUsedRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/licenses/#get-an-individual-license + */ + "GET /licenses/:license": { + parameters: LicensesGetEndpoint; + request: LicensesGetRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/marketplace/#get-a-subscription-plan-for-an-account + */ + "GET /marketplace_listing/accounts/:account_id": { + parameters: AppsGetSubscriptionPlanForAccountEndpoint; + request: AppsGetSubscriptionPlanForAccountRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/marketplace/#list-plans + */ + "GET /marketplace_listing/plans": { + parameters: AppsListPlansEndpoint; + request: AppsListPlansRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/marketplace/#list-accounts-for-a-plan + */ + "GET /marketplace_listing/plans/:plan_id/accounts": { + parameters: AppsListAccountsForPlanEndpoint; + request: AppsListAccountsForPlanRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/marketplace/#get-a-subscription-plan-for-an-account-stubbed + */ + "GET /marketplace_listing/stubbed/accounts/:account_id": { + parameters: AppsGetSubscriptionPlanForAccountStubbedEndpoint; + request: AppsGetSubscriptionPlanForAccountStubbedRequestOptions; + response: OctokitResponse< + AppsGetSubscriptionPlanForAccountStubbedResponseData + >; + }; + /** + * @see https://developer.github.com/v3/apps/marketplace/#list-plans-stubbed + */ + "GET /marketplace_listing/stubbed/plans": { + parameters: AppsListPlansStubbedEndpoint; + request: AppsListPlansStubbedRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/marketplace/#list-accounts-for-a-plan-stubbed + */ + "GET /marketplace_listing/stubbed/plans/:plan_id/accounts": { + parameters: AppsListAccountsForPlanStubbedEndpoint; + request: AppsListAccountsForPlanStubbedRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/meta/#meta + */ + "GET /meta": { + parameters: MetaGetEndpoint; + request: MetaGetRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/events/#list-public-events-for-a-network-of-repositories + */ + "GET /networks/:owner/:repo/events": { + parameters: ActivityListPublicEventsForRepoNetworkEndpoint; + request: ActivityListPublicEventsForRepoNetworkRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/notifications/#list-notifications-for-the-authenticated-user + */ + "GET /notifications": { + parameters: ActivityListNotificationsForAuthenticatedUserEndpoint; + request: ActivityListNotificationsForAuthenticatedUserRequestOptions; + response: OctokitResponse< + ActivityListNotificationsForAuthenticatedUserResponseData + >; + }; + /** + * @see https://developer.github.com/v3/activity/notifications/#get-a-thread + */ + "GET /notifications/threads/:thread_id": { + parameters: ActivityGetThreadEndpoint; + request: ActivityGetThreadRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/notifications/#get-a-thread-subscription-for-the-authenticated-user + */ + "GET /notifications/threads/:thread_id/subscription": { + parameters: ActivityGetThreadSubscriptionForAuthenticatedUserEndpoint; + request: ActivityGetThreadSubscriptionForAuthenticatedUserRequestOptions; + response: OctokitResponse< + ActivityGetThreadSubscriptionForAuthenticatedUserResponseData + >; + }; + /** + * @see https://developer.github.com/v3/orgs/#list-all-organizations + */ + "GET /organizations": { + parameters: OrgsListEndpoint; + request: OrgsListRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/#get-an-organization + */ + "GET /orgs/:org": { + parameters: OrgsGetEndpoint; + request: OrgsGetRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/self-hosted-runners/#list-self-hosted-runners-for-an-organization + */ + "GET /orgs/:org/actions/runners": { + parameters: ActionsListSelfHostedRunnersForOrgEndpoint; + request: ActionsListSelfHostedRunnersForOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/self-hosted-runners/#get-a-self-hosted-runner-for-an-organization + */ + "GET /orgs/:org/actions/runners/:runner_id": { + parameters: ActionsGetSelfHostedRunnerForOrgEndpoint; + request: ActionsGetSelfHostedRunnerForOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/self-hosted-runners/#list-runner-applications-for-an-organization + */ + "GET /orgs/:org/actions/runners/downloads": { + parameters: ActionsListRunnerApplicationsForOrgEndpoint; + request: ActionsListRunnerApplicationsForOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/blocking/#list-blocked-users + */ + "GET /orgs/:org/blocks": { + parameters: OrgsListBlockedUsersEndpoint; + request: OrgsListBlockedUsersRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/blocking/#check-whether-a-user-is-blocked-from-an-organization + */ + "GET /orgs/:org/blocks/:username": { + parameters: OrgsCheckBlockedUserEndpoint; + request: OrgsCheckBlockedUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/#list-credential-authorizations-for-an-organization + */ + "GET /orgs/:org/credential-authorizations": { + parameters: OrgsListCredentialAuthorizationsEndpoint; + request: OrgsListCredentialAuthorizationsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/events/#list-public-organization-events + */ + "GET /orgs/:org/events": { + parameters: ActivityListPublicOrgEventsEndpoint; + request: ActivityListPublicOrgEventsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/hooks/#list-hooks + */ + "GET /orgs/:org/hooks": { + parameters: OrgsListHooksEndpoint; + request: OrgsListHooksRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/hooks/#get-single-hook + */ + "GET /orgs/:org/hooks/:hook_id": { + parameters: OrgsGetHookEndpoint; + request: OrgsGetHookRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/#get-an-organization-installation + */ + "GET /orgs/:org/installation": { + parameters: AppsGetOrgInstallationEndpoint; + request: AppsGetOrgInstallationRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/#list-installations-for-an-organization + */ + "GET /orgs/:org/installations": { + parameters: OrgsListInstallationsEndpoint; + request: OrgsListInstallationsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/interactions/orgs/#get-interaction-restrictions-for-an-organization + */ + "GET /orgs/:org/interaction-limits": { + parameters: InteractionsGetRestrictionsForOrgEndpoint; + request: InteractionsGetRestrictionsForOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/members/#list-pending-organization-invitations + */ + "GET /orgs/:org/invitations": { + parameters: OrgsListPendingInvitationsEndpoint; + request: OrgsListPendingInvitationsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/members/#list-organization-invitation-teams + */ + "GET /orgs/:org/invitations/:invitation_id/teams": { + parameters: OrgsListInvitationTeamsEndpoint; + request: OrgsListInvitationTeamsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/#list-organization-issues-assigned-to-the-authenticated-user + */ + "GET /orgs/:org/issues": { + parameters: IssuesListForOrgEndpoint; + request: IssuesListForOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/members/#members-list + */ + "GET /orgs/:org/members": { + parameters: OrgsListMembersEndpoint; + request: OrgsListMembersRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/members/#check-membership + */ + "GET /orgs/:org/members/:username": { + parameters: OrgsCheckMembershipEndpoint; + request: OrgsCheckMembershipRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/members/#get-organization-membership + */ + "GET /orgs/:org/memberships/:username": { + parameters: OrgsGetMembershipEndpoint; + request: OrgsGetMembershipRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/migrations/orgs/#list-organization-migrations + */ + "GET /orgs/:org/migrations": { + parameters: MigrationsListForOrgEndpoint; + request: MigrationsListForOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/migrations/orgs/#get-the-status-of-an-organization-migration + */ + "GET /orgs/:org/migrations/:migration_id": { + parameters: MigrationsGetStatusForOrgEndpoint; + request: MigrationsGetStatusForOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/migrations/orgs/#download-an-organization-migration-archive + */ + "GET /orgs/:org/migrations/:migration_id/archive": { + parameters: MigrationsDownloadArchiveForOrgEndpoint; + request: MigrationsDownloadArchiveForOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/migrations/orgs/#list-repositories-in-an-organization-migration + */ + "GET /orgs/:org/migrations/:migration_id/repositories": { + parameters: MigrationsListReposForOrgEndpoint; + request: MigrationsListReposForOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/outside_collaborators/#list-outside-collaborators + */ + "GET /orgs/:org/outside_collaborators": { + parameters: OrgsListOutsideCollaboratorsEndpoint; + request: OrgsListOutsideCollaboratorsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/projects/#list-organization-projects + */ + "GET /orgs/:org/projects": { + parameters: ProjectsListForOrgEndpoint; + request: ProjectsListForOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/members/#public-members-list + */ + "GET /orgs/:org/public_members": { + parameters: OrgsListPublicMembersEndpoint; + request: OrgsListPublicMembersRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/members/#check-public-membership + */ + "GET /orgs/:org/public_members/:username": { + parameters: OrgsCheckPublicMembershipEndpoint; + request: OrgsCheckPublicMembershipRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/#list-organization-repositories + */ + "GET /orgs/:org/repos": { + parameters: ReposListForOrgEndpoint; + request: ReposListForOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/team_sync/#list-idp-groups-in-an-organization + */ + "GET /orgs/:org/team-sync/groups": { + parameters: TeamsListIdPGroupsForOrgEndpoint; + request: TeamsListIdPGroupsForOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/#list-teams + */ + "GET /orgs/:org/teams": { + parameters: TeamsListEndpoint; + request: TeamsListRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/#get-team-by-name + */ + "GET /orgs/:org/teams/:team_slug": { + parameters: TeamsGetByNameEndpoint; + request: TeamsGetByNameRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/discussions/#list-discussions + */ + "GET /orgs/:org/teams/:team_slug/discussions": { + parameters: TeamsListDiscussionsInOrgEndpoint; + request: TeamsListDiscussionsInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/discussions/#get-a-single-discussion + */ + "GET /orgs/:org/teams/:team_slug/discussions/:discussion_number": { + parameters: TeamsGetDiscussionInOrgEndpoint; + request: TeamsGetDiscussionInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/discussion_comments/#list-comments + */ + "GET /orgs/:org/teams/:team_slug/discussions/:discussion_number/comments": { + parameters: TeamsListDiscussionCommentsInOrgEndpoint; + request: TeamsListDiscussionCommentsInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/discussion_comments/#get-a-single-comment + */ + "GET /orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number": { + parameters: TeamsGetDiscussionCommentInOrgEndpoint; + request: TeamsGetDiscussionCommentInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/reactions/#list-reactions-for-a-team-discussion-comment + */ + "GET /orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number/reactions": { + parameters: ReactionsListForTeamDiscussionCommentInOrgEndpoint; + request: ReactionsListForTeamDiscussionCommentInOrgRequestOptions; + response: OctokitResponse< + ReactionsListForTeamDiscussionCommentInOrgResponseData + >; + }; + /** + * @see https://developer.github.com/v3/reactions/#list-reactions-for-a-team-discussion + */ + "GET /orgs/:org/teams/:team_slug/discussions/:discussion_number/reactions": { + parameters: ReactionsListForTeamDiscussionInOrgEndpoint; + request: ReactionsListForTeamDiscussionInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/members/#list-pending-team-invitations + */ + "GET /orgs/:org/teams/:team_slug/invitations": { + parameters: TeamsListPendingInvitationsInOrgEndpoint; + request: TeamsListPendingInvitationsInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/members/#list-team-members + */ + "GET /orgs/:org/teams/:team_slug/members": { + parameters: TeamsListMembersInOrgEndpoint; + request: TeamsListMembersInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/members/#get-team-membership + */ + "GET /orgs/:org/teams/:team_slug/memberships/:username": { + parameters: TeamsGetMembershipInOrgEndpoint; + request: TeamsGetMembershipInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/#list-team-projects + */ + "GET /orgs/:org/teams/:team_slug/projects": { + parameters: TeamsListProjectsInOrgEndpoint; + request: TeamsListProjectsInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/#review-a-team-project + */ + "GET /orgs/:org/teams/:team_slug/projects/:project_id": { + parameters: TeamsReviewProjectInOrgEndpoint; + request: TeamsReviewProjectInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/#list-team-repos + */ + "GET /orgs/:org/teams/:team_slug/repos": { + parameters: TeamsListReposInOrgEndpoint; + request: TeamsListReposInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/#check-if-a-team-manages-a-repository + */ + "GET /orgs/:org/teams/:team_slug/repos/:owner/:repo": { + parameters: TeamsCheckManagesRepoInOrgEndpoint; + request: TeamsCheckManagesRepoInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/team_sync/#list-idp-groups-for-a-team + */ + "GET /orgs/:org/teams/:team_slug/team-sync/group-mappings": { + parameters: TeamsListIdPGroupsInOrgEndpoint; + request: TeamsListIdPGroupsInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/#list-child-teams + */ + "GET /orgs/:org/teams/:team_slug/teams": { + parameters: TeamsListChildInOrgEndpoint; + request: TeamsListChildInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/projects/#get-a-project + */ + "GET /projects/:project_id": { + parameters: ProjectsGetEndpoint; + request: ProjectsGetRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/projects/collaborators/#list-collaborators + */ + "GET /projects/:project_id/collaborators": { + parameters: ProjectsListCollaboratorsEndpoint; + request: ProjectsListCollaboratorsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/projects/collaborators/#review-a-users-permission-level + */ + "GET /projects/:project_id/collaborators/:username/permission": { + parameters: ProjectsReviewUserPermissionLevelEndpoint; + request: ProjectsReviewUserPermissionLevelRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/projects/columns/#list-project-columns + */ + "GET /projects/:project_id/columns": { + parameters: ProjectsListColumnsEndpoint; + request: ProjectsListColumnsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/projects/columns/#get-a-project-column + */ + "GET /projects/columns/:column_id": { + parameters: ProjectsGetColumnEndpoint; + request: ProjectsGetColumnRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/projects/cards/#list-project-cards + */ + "GET /projects/columns/:column_id/cards": { + parameters: ProjectsListCardsEndpoint; + request: ProjectsListCardsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/projects/cards/#get-a-project-card + */ + "GET /projects/columns/cards/:card_id": { + parameters: ProjectsGetCardEndpoint; + request: ProjectsGetCardRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/rate_limit/#get-your-current-rate-limit-status + */ + "GET /rate_limit": { + parameters: RateLimitGetEndpoint; + request: RateLimitGetRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/#get-a-repository + */ + "GET /repos/:owner/:repo": { + parameters: ReposGetEndpoint; + request: ReposGetRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/contents/#get-archive-link + */ + "GET /repos/:owner/:repo/:archive_format/:ref": { + parameters: ReposGetArchiveLinkEndpoint; + request: ReposGetArchiveLinkRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/artifacts/#list-artifacts-for-a-repository + */ + "GET /repos/:owner/:repo/actions/artifacts": { + parameters: ActionsListArtifactsForRepoEndpoint; + request: ActionsListArtifactsForRepoRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/artifacts/#get-an-artifact + */ + "GET /repos/:owner/:repo/actions/artifacts/:artifact_id": { + parameters: ActionsGetArtifactEndpoint; + request: ActionsGetArtifactRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/artifacts/#download-an-artifact + */ + "GET /repos/:owner/:repo/actions/artifacts/:artifact_id/:archive_format": { + parameters: ActionsDownloadArtifactEndpoint; + request: ActionsDownloadArtifactRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/workflow-jobs/#get-a-workflow-job + */ + "GET /repos/:owner/:repo/actions/jobs/:job_id": { + parameters: ActionsGetWorkflowJobEndpoint; + request: ActionsGetWorkflowJobRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/workflow-jobs/#download-workflow-job-logs + */ + "GET /repos/:owner/:repo/actions/jobs/:job_id/logs": { + parameters: ActionsDownloadWorkflowJobLogsEndpoint; + request: ActionsDownloadWorkflowJobLogsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/self-hosted-runners/#list-self-hosted-runners-for-a-repository + */ + "GET /repos/:owner/:repo/actions/runners": { + parameters: ActionsListSelfHostedRunnersForRepoEndpoint; + request: ActionsListSelfHostedRunnersForRepoRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/self-hosted-runners/#get-a-self-hosted-runner-for-a-repository + */ + "GET /repos/:owner/:repo/actions/runners/:runner_id": { + parameters: ActionsGetSelfHostedRunnerForRepoEndpoint; + request: ActionsGetSelfHostedRunnerForRepoRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/self-hosted-runners/#list-runner-applications-for-a-repository + */ + "GET /repos/:owner/:repo/actions/runners/downloads": { + parameters: ActionsListRunnerApplicationsForRepoEndpoint; + request: ActionsListRunnerApplicationsForRepoRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/workflow-runs/#list-repository-workflow-runs + */ + "GET /repos/:owner/:repo/actions/runs": { + parameters: ActionsListRepoWorkflowRunsEndpoint; + request: ActionsListRepoWorkflowRunsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/workflow-runs/#get-a-workflow-run + */ + "GET /repos/:owner/:repo/actions/runs/:run_id": { + parameters: ActionsGetWorkflowRunEndpoint; + request: ActionsGetWorkflowRunRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/artifacts/#list-workflow-run-artifacts + */ + "GET /repos/:owner/:repo/actions/runs/:run_id/artifacts": { + parameters: ActionsListWorkflowRunArtifactsEndpoint; + request: ActionsListWorkflowRunArtifactsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/workflow-jobs/#list-jobs-for-a-workflow-run + */ + "GET /repos/:owner/:repo/actions/runs/:run_id/jobs": { + parameters: ActionsListJobsForWorkflowRunEndpoint; + request: ActionsListJobsForWorkflowRunRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/workflow-runs/#download-workflow-run-logs + */ + "GET /repos/:owner/:repo/actions/runs/:run_id/logs": { + parameters: ActionsDownloadWorkflowRunLogsEndpoint; + request: ActionsDownloadWorkflowRunLogsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/secrets/#list-secrets-for-a-repository + */ + "GET /repos/:owner/:repo/actions/secrets": { + parameters: ActionsListSecretsForRepoEndpoint; + request: ActionsListSecretsForRepoRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/secrets/#get-a-secret + */ + "GET /repos/:owner/:repo/actions/secrets/:name": { + parameters: ActionsGetSecretEndpoint; + request: ActionsGetSecretRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/secrets/#get-your-public-key + */ + "GET /repos/:owner/:repo/actions/secrets/public-key": { + parameters: ActionsGetPublicKeyEndpoint; + request: ActionsGetPublicKeyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/workflows/#list-repository-workflows + */ + "GET /repos/:owner/:repo/actions/workflows": { + parameters: ActionsListRepoWorkflowsEndpoint; + request: ActionsListRepoWorkflowsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/workflows/#get-a-workflow + */ + "GET /repos/:owner/:repo/actions/workflows/:workflow_id": { + parameters: ActionsGetWorkflowEndpoint; + request: ActionsGetWorkflowRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/workflow-runs/#list-workflow-runs + */ + "GET /repos/:owner/:repo/actions/workflows/:workflow_id/runs": { + parameters: ActionsListWorkflowRunsEndpoint; + request: ActionsListWorkflowRunsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/assignees/#list-assignees + */ + "GET /repos/:owner/:repo/assignees": { + parameters: IssuesListAssigneesEndpoint; + request: IssuesListAssigneesRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/assignees/#check-assignee + */ + "GET /repos/:owner/:repo/assignees/:assignee": { + parameters: IssuesCheckAssigneeEndpoint; + request: IssuesCheckAssigneeRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#list-branches + */ + "GET /repos/:owner/:repo/branches": { + parameters: ReposListBranchesEndpoint; + request: ReposListBranchesRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#get-branch + */ + "GET /repos/:owner/:repo/branches/:branch": { + parameters: ReposGetBranchEndpoint; + request: ReposGetBranchRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#get-branch-protection + */ + "GET /repos/:owner/:repo/branches/:branch/protection": { + parameters: ReposGetBranchProtectionEndpoint; + request: ReposGetBranchProtectionRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#get-admin-enforcement-of-protected-branch + */ + "GET /repos/:owner/:repo/branches/:branch/protection/enforce_admins": { + parameters: ReposGetProtectedBranchAdminEnforcementEndpoint; + request: ReposGetProtectedBranchAdminEnforcementRequestOptions; + response: OctokitResponse< + ReposGetProtectedBranchAdminEnforcementResponseData + >; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#get-pull-request-review-enforcement-of-protected-branch + */ + "GET /repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews": { + parameters: ReposGetProtectedBranchPullRequestReviewEnforcementEndpoint; + request: ReposGetProtectedBranchPullRequestReviewEnforcementRequestOptions; + response: OctokitResponse< + ReposGetProtectedBranchPullRequestReviewEnforcementResponseData + >; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#get-required-signatures-of-protected-branch + */ + "GET /repos/:owner/:repo/branches/:branch/protection/required_signatures": { + parameters: ReposGetProtectedBranchRequiredSignaturesEndpoint; + request: ReposGetProtectedBranchRequiredSignaturesRequestOptions; + response: OctokitResponse< + ReposGetProtectedBranchRequiredSignaturesResponseData + >; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#get-required-status-checks-of-protected-branch + */ + "GET /repos/:owner/:repo/branches/:branch/protection/required_status_checks": { + parameters: ReposGetProtectedBranchRequiredStatusChecksEndpoint; + request: ReposGetProtectedBranchRequiredStatusChecksRequestOptions; + response: OctokitResponse< + ReposGetProtectedBranchRequiredStatusChecksResponseData + >; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#list-required-status-checks-contexts-of-protected-branch + */ + "GET /repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts": { + parameters: ReposListProtectedBranchRequiredStatusChecksContextsEndpoint; + request: ReposListProtectedBranchRequiredStatusChecksContextsRequestOptions; + response: OctokitResponse< + ReposListProtectedBranchRequiredStatusChecksContextsResponseData + >; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#get-restrictions-of-protected-branch + */ + "GET /repos/:owner/:repo/branches/:branch/protection/restrictions": { + parameters: ReposGetProtectedBranchRestrictionsEndpoint; + request: ReposGetProtectedBranchRestrictionsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#list-apps-with-access-to-protected-branch + */ + "GET /repos/:owner/:repo/branches/:branch/protection/restrictions/apps": { + parameters: ReposGetAppsWithAccessToProtectedBranchEndpoint; + request: ReposGetAppsWithAccessToProtectedBranchRequestOptions; + response: OctokitResponse< + ReposGetAppsWithAccessToProtectedBranchResponseData + >; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#list-teams-with-access-to-protected-branch + */ + "GET /repos/:owner/:repo/branches/:branch/protection/restrictions/teams": { + parameters: ReposGetTeamsWithAccessToProtectedBranchEndpoint; + request: ReposGetTeamsWithAccessToProtectedBranchRequestOptions; + response: OctokitResponse< + ReposGetTeamsWithAccessToProtectedBranchResponseData + >; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#list-users-with-access-to-protected-branch + */ + "GET /repos/:owner/:repo/branches/:branch/protection/restrictions/users": { + parameters: ReposGetUsersWithAccessToProtectedBranchEndpoint; + request: ReposGetUsersWithAccessToProtectedBranchRequestOptions; + response: OctokitResponse< + ReposGetUsersWithAccessToProtectedBranchResponseData + >; + }; + /** + * @see https://developer.github.com/v3/checks/runs/#get-a-check-run + */ + "GET /repos/:owner/:repo/check-runs/:check_run_id": { + parameters: ChecksGetEndpoint; + request: ChecksGetRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/checks/runs/#list-check-run-annotations + */ + "GET /repos/:owner/:repo/check-runs/:check_run_id/annotations": { + parameters: ChecksListAnnotationsEndpoint; + request: ChecksListAnnotationsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/checks/suites/#get-a-check-suite + */ + "GET /repos/:owner/:repo/check-suites/:check_suite_id": { + parameters: ChecksGetSuiteEndpoint; + request: ChecksGetSuiteRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/checks/runs/#list-check-runs-in-a-check-suite + */ + "GET /repos/:owner/:repo/check-suites/:check_suite_id/check-runs": { + parameters: ChecksListForSuiteEndpoint; + request: ChecksListForSuiteRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/code-scanning/#list-code-scanning-alerts-for-a-repository + */ + "GET /repos/:owner/:repo/code-scanning/alerts": { + parameters: CodeScanningListAlertsForRepoEndpoint; + request: CodeScanningListAlertsForRepoRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/code-scanning/#get-a-code-scanning-alert + */ + "GET /repos/:owner/:repo/code-scanning/alerts/:alert_id": { + parameters: CodeScanningGetAlertEndpoint; + request: CodeScanningGetAlertRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/collaborators/#list-collaborators + */ + "GET /repos/:owner/:repo/collaborators": { + parameters: ReposListCollaboratorsEndpoint; + request: ReposListCollaboratorsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/collaborators/#check-if-a-user-is-a-collaborator + */ + "GET /repos/:owner/:repo/collaborators/:username": { + parameters: ReposCheckCollaboratorEndpoint; + request: ReposCheckCollaboratorRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/collaborators/#review-a-users-permission-level + */ + "GET /repos/:owner/:repo/collaborators/:username/permission": { + parameters: ReposGetCollaboratorPermissionLevelEndpoint; + request: ReposGetCollaboratorPermissionLevelRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/comments/#list-commit-comments-for-a-repository + */ + "GET /repos/:owner/:repo/comments": { + parameters: ReposListCommitCommentsEndpoint; + request: ReposListCommitCommentsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/comments/#get-a-single-commit-comment + */ + "GET /repos/:owner/:repo/comments/:comment_id": { + parameters: ReposGetCommitCommentEndpoint; + request: ReposGetCommitCommentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/reactions/#list-reactions-for-a-commit-comment + */ + "GET /repos/:owner/:repo/comments/:comment_id/reactions": { + parameters: ReactionsListForCommitCommentEndpoint; + request: ReactionsListForCommitCommentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/commits/#list-commits-on-a-repository + */ + "GET /repos/:owner/:repo/commits": { + parameters: ReposListCommitsEndpoint; + request: ReposListCommitsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/commits/#list-branches-for-head-commit + */ + "GET /repos/:owner/:repo/commits/:commit_sha/branches-where-head": { + parameters: ReposListBranchesForHeadCommitEndpoint; + request: ReposListBranchesForHeadCommitRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/comments/#list-comments-for-a-single-commit + */ + "GET /repos/:owner/:repo/commits/:commit_sha/comments": { + parameters: ReposListCommentsForCommitEndpoint; + request: ReposListCommentsForCommitRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/commits/#list-pull-requests-associated-with-commit + */ + "GET /repos/:owner/:repo/commits/:commit_sha/pulls": { + parameters: ReposListPullRequestsAssociatedWithCommitEndpoint; + request: ReposListPullRequestsAssociatedWithCommitRequestOptions; + response: OctokitResponse< + ReposListPullRequestsAssociatedWithCommitResponseData + >; + }; + /** + * @see https://developer.github.com/v3/repos/commits/#get-a-single-commit + */ + "GET /repos/:owner/:repo/commits/:ref": { + parameters: ReposGetCommitEndpoint; + request: ReposGetCommitRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/checks/runs/#list-check-runs-for-a-git-reference + */ + "GET /repos/:owner/:repo/commits/:ref/check-runs": { + parameters: ChecksListForRefEndpoint; + request: ChecksListForRefRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/checks/suites/#list-check-suites-for-a-git-reference + */ + "GET /repos/:owner/:repo/commits/:ref/check-suites": { + parameters: ChecksListSuitesForRefEndpoint; + request: ChecksListSuitesForRefRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/statuses/#get-the-combined-status-for-a-specific-ref + */ + "GET /repos/:owner/:repo/commits/:ref/status": { + parameters: ReposGetCombinedStatusForRefEndpoint; + request: ReposGetCombinedStatusForRefRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/statuses/#list-statuses-for-a-specific-ref + */ + "GET /repos/:owner/:repo/commits/:ref/statuses": { + parameters: ReposListStatusesForRefEndpoint; + request: ReposListStatusesForRefRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/codes_of_conduct/#get-the-contents-of-a-repositorys-code-of-conduct + */ + "GET /repos/:owner/:repo/community/code_of_conduct": { + parameters: CodesOfConductGetForRepoEndpoint; + request: CodesOfConductGetForRepoRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/community/#retrieve-community-profile-metrics + */ + "GET /repos/:owner/:repo/community/profile": { + parameters: ReposRetrieveCommunityProfileMetricsEndpoint; + request: ReposRetrieveCommunityProfileMetricsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/commits/#compare-two-commits + */ + "GET /repos/:owner/:repo/compare/:base...:head": { + parameters: ReposCompareCommitsEndpoint; + request: ReposCompareCommitsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/contents/#get-contents + */ + "GET /repos/:owner/:repo/contents/:path": { + parameters: ReposGetContentsEndpoint; + request: ReposGetContentsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/#list-contributors + */ + "GET /repos/:owner/:repo/contributors": { + parameters: ReposListContributorsEndpoint; + request: ReposListContributorsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/deployments/#list-deployments + */ + "GET /repos/:owner/:repo/deployments": { + parameters: ReposListDeploymentsEndpoint; + request: ReposListDeploymentsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/deployments/#get-a-single-deployment + */ + "GET /repos/:owner/:repo/deployments/:deployment_id": { + parameters: ReposGetDeploymentEndpoint; + request: ReposGetDeploymentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/deployments/#list-deployment-statuses + */ + "GET /repos/:owner/:repo/deployments/:deployment_id/statuses": { + parameters: ReposListDeploymentStatusesEndpoint; + request: ReposListDeploymentStatusesRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/deployments/#get-a-single-deployment-status + */ + "GET /repos/:owner/:repo/deployments/:deployment_id/statuses/:status_id": { + parameters: ReposGetDeploymentStatusEndpoint; + request: ReposGetDeploymentStatusRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/downloads/#list-downloads-for-a-repository + */ + "GET /repos/:owner/:repo/downloads": { + parameters: ReposListDownloadsEndpoint; + request: ReposListDownloadsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/downloads/#get-a-single-download + */ + "GET /repos/:owner/:repo/downloads/:download_id": { + parameters: ReposGetDownloadEndpoint; + request: ReposGetDownloadRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/events/#list-repository-events + */ + "GET /repos/:owner/:repo/events": { + parameters: ActivityListRepoEventsEndpoint; + request: ActivityListRepoEventsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/forks/#list-forks + */ + "GET /repos/:owner/:repo/forks": { + parameters: ReposListForksEndpoint; + request: ReposListForksRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/git/blobs/#get-a-blob + */ + "GET /repos/:owner/:repo/git/blobs/:file_sha": { + parameters: GitGetBlobEndpoint; + request: GitGetBlobRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/git/commits/#get-a-commit + */ + "GET /repos/:owner/:repo/git/commits/:commit_sha": { + parameters: GitGetCommitEndpoint; + request: GitGetCommitRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/git/refs/#list-matching-references + */ + "GET /repos/:owner/:repo/git/matching-refs/:ref": { + parameters: GitListMatchingRefsEndpoint; + request: GitListMatchingRefsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/git/refs/#get-a-single-reference + */ + "GET /repos/:owner/:repo/git/ref/:ref": { + parameters: GitGetRefEndpoint; + request: GitGetRefRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/git/tags/#get-a-tag + */ + "GET /repos/:owner/:repo/git/tags/:tag_sha": { + parameters: GitGetTagEndpoint; + request: GitGetTagRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/git/trees/#get-a-tree + */ + "GET /repos/:owner/:repo/git/trees/:tree_sha": { + parameters: GitGetTreeEndpoint; + request: GitGetTreeRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/hooks/#list-hooks + */ + "GET /repos/:owner/:repo/hooks": { + parameters: ReposListHooksEndpoint; + request: ReposListHooksRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/hooks/#get-single-hook + */ + "GET /repos/:owner/:repo/hooks/:hook_id": { + parameters: ReposGetHookEndpoint; + request: ReposGetHookRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/migrations/source_imports/#get-import-progress + */ + "GET /repos/:owner/:repo/import": { + parameters: MigrationsGetImportProgressEndpoint; + request: MigrationsGetImportProgressRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/migrations/source_imports/#get-commit-authors + */ + "GET /repos/:owner/:repo/import/authors": { + parameters: MigrationsGetCommitAuthorsEndpoint; + request: MigrationsGetCommitAuthorsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/migrations/source_imports/#get-large-files + */ + "GET /repos/:owner/:repo/import/large_files": { + parameters: MigrationsGetLargeFilesEndpoint; + request: MigrationsGetLargeFilesRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/#get-a-repository-installation + */ + "GET /repos/:owner/:repo/installation": { + parameters: AppsGetRepoInstallationEndpoint; + request: AppsGetRepoInstallationRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/interactions/repos/#get-interaction-restrictions-for-a-repository + */ + "GET /repos/:owner/:repo/interaction-limits": { + parameters: InteractionsGetRestrictionsForRepoEndpoint; + request: InteractionsGetRestrictionsForRepoRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/invitations/#list-invitations-for-a-repository + */ + "GET /repos/:owner/:repo/invitations": { + parameters: ReposListInvitationsEndpoint; + request: ReposListInvitationsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/#list-repository-issues + */ + "GET /repos/:owner/:repo/issues": { + parameters: IssuesListForRepoEndpoint; + request: IssuesListForRepoRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/#get-an-issue + */ + "GET /repos/:owner/:repo/issues/:issue_number": { + parameters: IssuesGetEndpoint; + request: IssuesGetRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/comments/#list-comments-on-an-issue + */ + "GET /repos/:owner/:repo/issues/:issue_number/comments": { + parameters: IssuesListCommentsEndpoint; + request: IssuesListCommentsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/events/#list-events-for-an-issue + */ + "GET /repos/:owner/:repo/issues/:issue_number/events": { + parameters: IssuesListEventsEndpoint; + request: IssuesListEventsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/labels/#list-labels-on-an-issue + */ + "GET /repos/:owner/:repo/issues/:issue_number/labels": { + parameters: IssuesListLabelsOnIssueEndpoint; + request: IssuesListLabelsOnIssueRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/reactions/#list-reactions-for-an-issue + */ + "GET /repos/:owner/:repo/issues/:issue_number/reactions": { + parameters: ReactionsListForIssueEndpoint; + request: ReactionsListForIssueRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/timeline/#list-events-for-an-issue + */ + "GET /repos/:owner/:repo/issues/:issue_number/timeline": { + parameters: IssuesListEventsForTimelineEndpoint; + request: IssuesListEventsForTimelineRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/comments/#list-comments-in-a-repository + */ + "GET /repos/:owner/:repo/issues/comments": { + parameters: IssuesListCommentsForRepoEndpoint; + request: IssuesListCommentsForRepoRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/comments/#get-a-single-comment + */ + "GET /repos/:owner/:repo/issues/comments/:comment_id": { + parameters: IssuesGetCommentEndpoint; + request: IssuesGetCommentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/reactions/#list-reactions-for-an-issue-comment + */ + "GET /repos/:owner/:repo/issues/comments/:comment_id/reactions": { + parameters: ReactionsListForIssueCommentEndpoint; + request: ReactionsListForIssueCommentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/events/#list-events-for-a-repository + */ + "GET /repos/:owner/:repo/issues/events": { + parameters: IssuesListEventsForRepoEndpoint; + request: IssuesListEventsForRepoRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/events/#get-a-single-event + */ + "GET /repos/:owner/:repo/issues/events/:event_id": { + parameters: IssuesGetEventEndpoint; + request: IssuesGetEventRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/keys/#list-deploy-keys + */ + "GET /repos/:owner/:repo/keys": { + parameters: ReposListDeployKeysEndpoint; + request: ReposListDeployKeysRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/keys/#get-a-deploy-key + */ + "GET /repos/:owner/:repo/keys/:key_id": { + parameters: ReposGetDeployKeyEndpoint; + request: ReposGetDeployKeyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/labels/#list-all-labels-for-this-repository + */ + "GET /repos/:owner/:repo/labels": { + parameters: IssuesListLabelsForRepoEndpoint; + request: IssuesListLabelsForRepoRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/labels/#get-a-single-label + */ + "GET /repos/:owner/:repo/labels/:name": { + parameters: IssuesGetLabelEndpoint; + request: IssuesGetLabelRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/#list-languages + */ + "GET /repos/:owner/:repo/languages": { + parameters: ReposListLanguagesEndpoint; + request: ReposListLanguagesRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/licenses/#get-the-contents-of-a-repositorys-license + */ + "GET /repos/:owner/:repo/license": { + parameters: LicensesGetForRepoEndpoint; + request: LicensesGetForRepoRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/milestones/#list-milestones-for-a-repository + */ + "GET /repos/:owner/:repo/milestones": { + parameters: IssuesListMilestonesForRepoEndpoint; + request: IssuesListMilestonesForRepoRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/milestones/#get-a-single-milestone + */ + "GET /repos/:owner/:repo/milestones/:milestone_number": { + parameters: IssuesGetMilestoneEndpoint; + request: IssuesGetMilestoneRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/labels/#get-labels-for-every-issue-in-a-milestone + */ + "GET /repos/:owner/:repo/milestones/:milestone_number/labels": { + parameters: IssuesListLabelsForMilestoneEndpoint; + request: IssuesListLabelsForMilestoneRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/notifications/#list-repository-notifications-for-the-authenticated-user + */ + "GET /repos/:owner/:repo/notifications": { + parameters: ActivityListRepoNotificationsForAuthenticatedUserEndpoint; + request: ActivityListRepoNotificationsForAuthenticatedUserRequestOptions; + response: OctokitResponse< + ActivityListRepoNotificationsForAuthenticatedUserResponseData + >; + }; + /** + * @see https://developer.github.com/v3/repos/pages/#get-information-about-a-pages-site + */ + "GET /repos/:owner/:repo/pages": { + parameters: ReposGetPagesEndpoint; + request: ReposGetPagesRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/pages/#list-pages-builds + */ + "GET /repos/:owner/:repo/pages/builds": { + parameters: ReposListPagesBuildsEndpoint; + request: ReposListPagesBuildsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/pages/#get-a-specific-pages-build + */ + "GET /repos/:owner/:repo/pages/builds/:build_id": { + parameters: ReposGetPagesBuildEndpoint; + request: ReposGetPagesBuildRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/pages/#get-latest-pages-build + */ + "GET /repos/:owner/:repo/pages/builds/latest": { + parameters: ReposGetLatestPagesBuildEndpoint; + request: ReposGetLatestPagesBuildRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/projects/#list-repository-projects + */ + "GET /repos/:owner/:repo/projects": { + parameters: ProjectsListForRepoEndpoint; + request: ProjectsListForRepoRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/pulls/#list-pull-requests + */ + "GET /repos/:owner/:repo/pulls": { + parameters: PullsListEndpoint; + request: PullsListRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/pulls/#get-a-single-pull-request + */ + "GET /repos/:owner/:repo/pulls/:pull_number": { + parameters: PullsGetEndpoint; + request: PullsGetRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/pulls/comments/#list-comments-on-a-pull-request + */ + "GET /repos/:owner/:repo/pulls/:pull_number/comments": { + parameters: PullsListCommentsEndpoint; + request: PullsListCommentsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/pulls/#list-commits-on-a-pull-request + */ + "GET /repos/:owner/:repo/pulls/:pull_number/commits": { + parameters: PullsListCommitsEndpoint; + request: PullsListCommitsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/pulls/#list-pull-requests-files + */ + "GET /repos/:owner/:repo/pulls/:pull_number/files": { + parameters: PullsListFilesEndpoint; + request: PullsListFilesRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/pulls/#get-if-a-pull-request-has-been-merged + */ + "GET /repos/:owner/:repo/pulls/:pull_number/merge": { + parameters: PullsCheckIfMergedEndpoint; + request: PullsCheckIfMergedRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/pulls/review_requests/#list-review-requests + */ + "GET /repos/:owner/:repo/pulls/:pull_number/requested_reviewers": { + parameters: PullsListReviewRequestsEndpoint; + request: PullsListReviewRequestsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/pulls/reviews/#list-reviews-on-a-pull-request + */ + "GET /repos/:owner/:repo/pulls/:pull_number/reviews": { + parameters: PullsListReviewsEndpoint; + request: PullsListReviewsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/pulls/reviews/#get-a-single-review + */ + "GET /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id": { + parameters: PullsGetReviewEndpoint; + request: PullsGetReviewRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/pulls/reviews/#get-comments-for-a-single-review + */ + "GET /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/comments": { + parameters: PullsGetCommentsForReviewEndpoint; + request: PullsGetCommentsForReviewRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/pulls/comments/#list-comments-in-a-repository + */ + "GET /repos/:owner/:repo/pulls/comments": { + parameters: PullsListCommentsForRepoEndpoint; + request: PullsListCommentsForRepoRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/pulls/comments/#get-a-single-comment + */ + "GET /repos/:owner/:repo/pulls/comments/:comment_id": { + parameters: PullsGetCommentEndpoint; + request: PullsGetCommentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/reactions/#list-reactions-for-a-pull-request-review-comment + */ + "GET /repos/:owner/:repo/pulls/comments/:comment_id/reactions": { + parameters: ReactionsListForPullRequestReviewCommentEndpoint; + request: ReactionsListForPullRequestReviewCommentRequestOptions; + response: OctokitResponse< + ReactionsListForPullRequestReviewCommentResponseData + >; + }; + /** + * @see https://developer.github.com/v3/repos/contents/#get-the-readme + */ + "GET /repos/:owner/:repo/readme": { + parameters: ReposGetReadmeEndpoint; + request: ReposGetReadmeRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/releases/#list-releases-for-a-repository + */ + "GET /repos/:owner/:repo/releases": { + parameters: ReposListReleasesEndpoint; + request: ReposListReleasesRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/releases/#get-a-single-release + */ + "GET /repos/:owner/:repo/releases/:release_id": { + parameters: ReposGetReleaseEndpoint; + request: ReposGetReleaseRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/releases/#list-assets-for-a-release + */ + "GET /repos/:owner/:repo/releases/:release_id/assets": { + parameters: ReposListAssetsForReleaseEndpoint; + request: ReposListAssetsForReleaseRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/releases/#get-a-single-release-asset + */ + "GET /repos/:owner/:repo/releases/assets/:asset_id": { + parameters: ReposGetReleaseAssetEndpoint; + request: ReposGetReleaseAssetRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/releases/#get-the-latest-release + */ + "GET /repos/:owner/:repo/releases/latest": { + parameters: ReposGetLatestReleaseEndpoint; + request: ReposGetLatestReleaseRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/releases/#get-a-release-by-tag-name + */ + "GET /repos/:owner/:repo/releases/tags/:tag": { + parameters: ReposGetReleaseByTagEndpoint; + request: ReposGetReleaseByTagRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/starring/#list-stargazers + */ + "GET /repos/:owner/:repo/stargazers": { + parameters: ActivityListStargazersForRepoEndpoint; + request: ActivityListStargazersForRepoRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/statistics/#get-the-number-of-additions-and-deletions-per-week + */ + "GET /repos/:owner/:repo/stats/code_frequency": { + parameters: ReposGetCodeFrequencyStatsEndpoint; + request: ReposGetCodeFrequencyStatsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/statistics/#get-the-last-year-of-commit-activity-data + */ + "GET /repos/:owner/:repo/stats/commit_activity": { + parameters: ReposGetCommitActivityStatsEndpoint; + request: ReposGetCommitActivityStatsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/statistics/#get-contributors-list-with-additions-deletions-and-commit-counts + */ + "GET /repos/:owner/:repo/stats/contributors": { + parameters: ReposGetContributorsStatsEndpoint; + request: ReposGetContributorsStatsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/statistics/#get-the-weekly-commit-count-for-the-repository-owner-and-everyone-else + */ + "GET /repos/:owner/:repo/stats/participation": { + parameters: ReposGetParticipationStatsEndpoint; + request: ReposGetParticipationStatsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/statistics/#get-the-number-of-commits-per-hour-in-each-day + */ + "GET /repos/:owner/:repo/stats/punch_card": { + parameters: ReposGetPunchCardStatsEndpoint; + request: ReposGetPunchCardStatsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/watching/#list-watchers + */ + "GET /repos/:owner/:repo/subscribers": { + parameters: ActivityListWatchersForRepoEndpoint; + request: ActivityListWatchersForRepoRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/watching/#get-a-repository-subscription + */ + "GET /repos/:owner/:repo/subscription": { + parameters: ActivityGetRepoSubscriptionEndpoint; + request: ActivityGetRepoSubscriptionRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/#list-tags + */ + "GET /repos/:owner/:repo/tags": { + parameters: ReposListTagsEndpoint; + request: ReposListTagsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/#list-teams + */ + "GET /repos/:owner/:repo/teams": { + parameters: ReposListTeamsEndpoint; + request: ReposListTeamsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/#get-all-repository-topics + */ + "GET /repos/:owner/:repo/topics": { + parameters: ReposGetAllTopicsEndpoint; + request: ReposGetAllTopicsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/traffic/#clones + */ + "GET /repos/:owner/:repo/traffic/clones": { + parameters: ReposGetClonesEndpoint; + request: ReposGetClonesRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/traffic/#list-paths + */ + "GET /repos/:owner/:repo/traffic/popular/paths": { + parameters: ReposGetTopPathsEndpoint; + request: ReposGetTopPathsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/traffic/#list-referrers + */ + "GET /repos/:owner/:repo/traffic/popular/referrers": { + parameters: ReposGetTopReferrersEndpoint; + request: ReposGetTopReferrersRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/traffic/#views + */ + "GET /repos/:owner/:repo/traffic/views": { + parameters: ReposGetViewsEndpoint; + request: ReposGetViewsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/#check-if-vulnerability-alerts-are-enabled-for-a-repository + */ + "GET /repos/:owner/:repo/vulnerability-alerts": { + parameters: ReposCheckVulnerabilityAlertsEndpoint; + request: ReposCheckVulnerabilityAlertsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/#list-public-repositories + */ + "GET /repositories": { + parameters: ReposListPublicEndpoint; + request: ReposListPublicRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/scim/#get-a-list-of-provisioned-identities + */ + "GET /scim/v2/organizations/:org/Users": { + parameters: ScimListProvisionedIdentitiesEndpoint; + request: ScimListProvisionedIdentitiesRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/scim/#get-provisioning-details-for-a-single-user + */ + "GET /scim/v2/organizations/:org/Users/:scim_user_id": { + parameters: ScimGetProvisioningDetailsForUserEndpoint; + request: ScimGetProvisioningDetailsForUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/search/#search-code + */ + "GET /search/code": { + parameters: SearchCodeEndpoint; + request: SearchCodeRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/search/#search-commits + */ + "GET /search/commits": { + parameters: SearchCommitsEndpoint; + request: SearchCommitsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/search/#search-issues-and-pull-requests + */ + "GET /search/issues": { + parameters: SearchIssuesAndPullRequestsEndpoint; + request: SearchIssuesAndPullRequestsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/search/#search-labels + */ + "GET /search/labels": { + parameters: SearchLabelsEndpoint; + request: SearchLabelsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/search/#search-repositories + */ + "GET /search/repositories": { + parameters: SearchReposEndpoint; + request: SearchReposRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/search/#search-topics + */ + "GET /search/topics": { + parameters: SearchTopicsEndpoint; + request: SearchTopicsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/search/#search-users + */ + "GET /search/users": { + parameters: SearchUsersEndpoint; + request: SearchUsersRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/#get-team-legacy + */ + "GET /teams/:team_id": { + parameters: TeamsGetLegacyEndpoint; + request: TeamsGetLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/discussions/#list-discussions-legacy + */ + "GET /teams/:team_id/discussions": { + parameters: TeamsListDiscussionsLegacyEndpoint; + request: TeamsListDiscussionsLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/discussions/#get-a-single-discussion-legacy + */ + "GET /teams/:team_id/discussions/:discussion_number": { + parameters: TeamsGetDiscussionLegacyEndpoint; + request: TeamsGetDiscussionLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/discussion_comments/#list-comments-legacy + */ + "GET /teams/:team_id/discussions/:discussion_number/comments": { + parameters: TeamsListDiscussionCommentsLegacyEndpoint; + request: TeamsListDiscussionCommentsLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/discussion_comments/#get-a-single-comment-legacy + */ + "GET /teams/:team_id/discussions/:discussion_number/comments/:comment_number": { + parameters: TeamsGetDiscussionCommentLegacyEndpoint; + request: TeamsGetDiscussionCommentLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/reactions/#list-reactions-for-a-team-discussion-comment-legacy + */ + "GET /teams/:team_id/discussions/:discussion_number/comments/:comment_number/reactions": { + parameters: ReactionsListForTeamDiscussionCommentLegacyEndpoint; + request: ReactionsListForTeamDiscussionCommentLegacyRequestOptions; + response: OctokitResponse< + ReactionsListForTeamDiscussionCommentLegacyResponseData + >; + }; + /** + * @see https://developer.github.com/v3/reactions/#list-reactions-for-a-team-discussion-legacy + */ + "GET /teams/:team_id/discussions/:discussion_number/reactions": { + parameters: ReactionsListForTeamDiscussionLegacyEndpoint; + request: ReactionsListForTeamDiscussionLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/members/#list-pending-team-invitations-legacy + */ + "GET /teams/:team_id/invitations": { + parameters: TeamsListPendingInvitationsLegacyEndpoint; + request: TeamsListPendingInvitationsLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/members/#list-team-members-legacy + */ + "GET /teams/:team_id/members": { + parameters: TeamsListMembersLegacyEndpoint; + request: TeamsListMembersLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/members/#get-team-member-legacy + */ + "GET /teams/:team_id/members/:username": { + parameters: TeamsGetMemberLegacyEndpoint; + request: TeamsGetMemberLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/members/#get-team-membership-legacy + */ + "GET /teams/:team_id/memberships/:username": { + parameters: TeamsGetMembershipLegacyEndpoint; + request: TeamsGetMembershipLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/#list-team-projects-legacy + */ + "GET /teams/:team_id/projects": { + parameters: TeamsListProjectsLegacyEndpoint; + request: TeamsListProjectsLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/#review-a-team-project-legacy + */ + "GET /teams/:team_id/projects/:project_id": { + parameters: TeamsReviewProjectLegacyEndpoint; + request: TeamsReviewProjectLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/#list-team-repos-legacy + */ + "GET /teams/:team_id/repos": { + parameters: TeamsListReposLegacyEndpoint; + request: TeamsListReposLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/#check-if-a-team-manages-a-repository-legacy + */ + "GET /teams/:team_id/repos/:owner/:repo": { + parameters: TeamsCheckManagesRepoLegacyEndpoint; + request: TeamsCheckManagesRepoLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/team_sync/#list-idp-groups-for-a-team-legacy + */ + "GET /teams/:team_id/team-sync/group-mappings": { + parameters: TeamsListIdPGroupsForLegacyEndpoint; + request: TeamsListIdPGroupsForLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/#list-child-teams-legacy + */ + "GET /teams/:team_id/teams": { + parameters: TeamsListChildLegacyEndpoint; + request: TeamsListChildLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/#get-the-authenticated-user + */ + "GET /user": { + parameters: UsersGetAuthenticatedEndpoint; + request: UsersGetAuthenticatedRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/migrations/users/#list-repositories-for-a-user-migration + */ + "GET /user/:migration_id/repositories": { + parameters: MigrationsListReposForUserEndpoint; + request: MigrationsListReposForUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/blocking/#list-blocked-users + */ + "GET /user/blocks": { + parameters: UsersListBlockedEndpoint; + request: UsersListBlockedRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/blocking/#check-whether-youve-blocked-a-user + */ + "GET /user/blocks/:username": { + parameters: UsersCheckBlockedEndpoint; + request: UsersCheckBlockedRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/emails/#list-email-addresses-for-a-user + */ + "GET /user/emails": { + parameters: UsersListEmailsEndpoint; + request: UsersListEmailsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/followers/#list-followers-of-the-authenticated-user + */ + "GET /user/followers": { + parameters: UsersListFollowersForAuthenticatedUserEndpoint; + request: UsersListFollowersForAuthenticatedUserRequestOptions; + response: OctokitResponse< + UsersListFollowersForAuthenticatedUserResponseData + >; + }; + /** + * @see https://developer.github.com/v3/users/followers/#list-users-followed-by-the-authenticated-user + */ + "GET /user/following": { + parameters: UsersListFollowedByAuthenticatedEndpoint; + request: UsersListFollowedByAuthenticatedRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/followers/#check-if-you-are-following-a-user + */ + "GET /user/following/:username": { + parameters: UsersCheckFollowingEndpoint; + request: UsersCheckFollowingRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/gpg_keys/#list-your-gpg-keys + */ + "GET /user/gpg_keys": { + parameters: UsersListGpgKeysEndpoint; + request: UsersListGpgKeysRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/gpg_keys/#get-a-single-gpg-key + */ + "GET /user/gpg_keys/:gpg_key_id": { + parameters: UsersGetGpgKeyEndpoint; + request: UsersGetGpgKeyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/installations/#list-installations-for-a-user + */ + "GET /user/installations": { + parameters: AppsListInstallationsForAuthenticatedUserEndpoint; + request: AppsListInstallationsForAuthenticatedUserRequestOptions; + response: OctokitResponse< + AppsListInstallationsForAuthenticatedUserResponseData + >; + }; + /** + * @see https://developer.github.com/v3/apps/installations/#list-repositories-accessible-to-the-user-for-an-installation + */ + "GET /user/installations/:installation_id/repositories": { + parameters: AppsListInstallationReposForAuthenticatedUserEndpoint; + request: AppsListInstallationReposForAuthenticatedUserRequestOptions; + response: OctokitResponse< + AppsListInstallationReposForAuthenticatedUserResponseData + >; + }; + /** + * @see https://developer.github.com/v3/issues/#list-user-account-issues-assigned-to-the-authenticated-user + */ + "GET /user/issues": { + parameters: IssuesListForAuthenticatedUserEndpoint; + request: IssuesListForAuthenticatedUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/keys/#list-your-public-keys + */ + "GET /user/keys": { + parameters: UsersListPublicKeysEndpoint; + request: UsersListPublicKeysRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/keys/#get-a-single-public-key + */ + "GET /user/keys/:key_id": { + parameters: UsersGetPublicKeyEndpoint; + request: UsersGetPublicKeyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/marketplace/#list-subscriptions-for-the-authenticated-user + */ + "GET /user/marketplace_purchases": { + parameters: AppsListSubscriptionsForAuthenticatedUserEndpoint; + request: AppsListSubscriptionsForAuthenticatedUserRequestOptions; + response: OctokitResponse< + AppsListSubscriptionsForAuthenticatedUserResponseData + >; + }; + /** + * @see https://developer.github.com/v3/apps/marketplace/#list-subscriptions-for-the-authenticated-user-stubbed + */ + "GET /user/marketplace_purchases/stubbed": { + parameters: AppsListSubscriptionsForAuthenticatedUserStubbedEndpoint; + request: AppsListSubscriptionsForAuthenticatedUserStubbedRequestOptions; + response: OctokitResponse< + AppsListSubscriptionsForAuthenticatedUserStubbedResponseData + >; + }; + /** + * @see https://developer.github.com/v3/orgs/members/#list-your-organization-memberships + */ + "GET /user/memberships/orgs": { + parameters: OrgsListMembershipsEndpoint; + request: OrgsListMembershipsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/members/#get-your-organization-membership + */ + "GET /user/memberships/orgs/:org": { + parameters: OrgsGetMembershipForAuthenticatedUserEndpoint; + request: OrgsGetMembershipForAuthenticatedUserRequestOptions; + response: OctokitResponse< + OrgsGetMembershipForAuthenticatedUserResponseData + >; + }; + /** + * @see https://developer.github.com/v3/migrations/users/#list-user-migrations + */ + "GET /user/migrations": { + parameters: MigrationsListForAuthenticatedUserEndpoint; + request: MigrationsListForAuthenticatedUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/migrations/users/#get-the-status-of-a-user-migration + */ + "GET /user/migrations/:migration_id": { + parameters: MigrationsGetStatusForAuthenticatedUserEndpoint; + request: MigrationsGetStatusForAuthenticatedUserRequestOptions; + response: OctokitResponse< + MigrationsGetStatusForAuthenticatedUserResponseData + >; + }; + /** + * @see https://developer.github.com/v3/migrations/users/#download-a-user-migration-archive + */ + "GET /user/migrations/:migration_id/archive": { + parameters: MigrationsGetArchiveForAuthenticatedUserEndpoint; + request: MigrationsGetArchiveForAuthenticatedUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/#list-your-organizations + */ + "GET /user/orgs": { + parameters: OrgsListForAuthenticatedUserEndpoint; + request: OrgsListForAuthenticatedUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/emails/#list-public-email-addresses-for-a-user + */ + "GET /user/public_emails": { + parameters: UsersListPublicEmailsEndpoint; + request: UsersListPublicEmailsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/#list-repositories-for-the-authenticated-user + */ + "GET /user/repos": { + parameters: ReposListForAuthenticatedUserEndpoint; + request: ReposListForAuthenticatedUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/invitations/#list-a-users-repository-invitations + */ + "GET /user/repository_invitations": { + parameters: ReposListInvitationsForAuthenticatedUserEndpoint; + request: ReposListInvitationsForAuthenticatedUserRequestOptions; + response: OctokitResponse< + ReposListInvitationsForAuthenticatedUserResponseData + >; + }; + /** + * @see https://developer.github.com/v3/activity/starring/#list-repositories-starred-by-the-authenticated-user + */ + "GET /user/starred": { + parameters: ActivityListReposStarredByAuthenticatedUserEndpoint; + request: ActivityListReposStarredByAuthenticatedUserRequestOptions; + response: OctokitResponse< + ActivityListReposStarredByAuthenticatedUserResponseData + >; + }; + /** + * @see https://developer.github.com/v3/activity/starring/#check-if-a-repository-is-starred-by-the-authenticated-user + */ + "GET /user/starred/:owner/:repo": { + parameters: ActivityCheckRepoIsStarredByAuthenticatedUserEndpoint; + request: ActivityCheckRepoIsStarredByAuthenticatedUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/watching/#list-repositories-watched-by-the-authenticated-user + */ + "GET /user/subscriptions": { + parameters: ActivityListWatchedReposForAuthenticatedUserEndpoint; + request: ActivityListWatchedReposForAuthenticatedUserRequestOptions; + response: OctokitResponse< + ActivityListWatchedReposForAuthenticatedUserResponseData + >; + }; + /** + * @see https://developer.github.com/v3/activity/watching/#check-if-you-are-watching-a-repository-legacy + */ + "GET /user/subscriptions/:owner/:repo": { + parameters: ActivityCheckWatchingRepoLegacyEndpoint; + request: ActivityCheckWatchingRepoLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/#list-user-teams + */ + "GET /user/teams": { + parameters: TeamsListForAuthenticatedUserEndpoint; + request: TeamsListForAuthenticatedUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/#get-all-users + */ + "GET /users": { + parameters: UsersListEndpoint; + request: UsersListRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/#get-a-single-user + */ + "GET /users/:username": { + parameters: UsersGetByUsernameEndpoint; + request: UsersGetByUsernameRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/events/#list-events-for-the-authenticated-user + */ + "GET /users/:username/events": { + parameters: ActivityListEventsForAuthenticatedUserEndpoint; + request: ActivityListEventsForAuthenticatedUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/events/#list-organization-events-for-the-authenticated-user + */ + "GET /users/:username/events/orgs/:org": { + parameters: ActivityListOrgEventsForAuthenticatedUserEndpoint; + request: ActivityListOrgEventsForAuthenticatedUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/events/#list-public-events-for-a-user + */ + "GET /users/:username/events/public": { + parameters: ActivityListPublicEventsForUserEndpoint; + request: ActivityListPublicEventsForUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/followers/#list-followers-of-a-user + */ + "GET /users/:username/followers": { + parameters: UsersListFollowersForUserEndpoint; + request: UsersListFollowersForUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/followers/#list-users-followed-by-another-user + */ + "GET /users/:username/following": { + parameters: UsersListFollowingForUserEndpoint; + request: UsersListFollowingForUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/followers/#check-if-one-user-follows-another + */ + "GET /users/:username/following/:target_user": { + parameters: UsersCheckFollowingForUserEndpoint; + request: UsersCheckFollowingForUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/gists/#list-gists-for-a-user + */ + "GET /users/:username/gists": { + parameters: GistsListForUserEndpoint; + request: GistsListForUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/gpg_keys/#list-gpg-keys-for-a-user + */ + "GET /users/:username/gpg_keys": { + parameters: UsersListGpgKeysForUserEndpoint; + request: UsersListGpgKeysForUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/#get-contextual-information-about-a-user + */ + "GET /users/:username/hovercard": { + parameters: UsersGetContextForUserEndpoint; + request: UsersGetContextForUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/#get-a-user-installation + */ + "GET /users/:username/installation": { + parameters: AppsGetUserInstallationEndpoint; + request: AppsGetUserInstallationRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/keys/#list-public-keys-for-a-user + */ + "GET /users/:username/keys": { + parameters: UsersListPublicKeysForUserEndpoint; + request: UsersListPublicKeysForUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/#list-user-organizations + */ + "GET /users/:username/orgs": { + parameters: OrgsListForUserEndpoint; + request: OrgsListForUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/projects/#list-user-projects + */ + "GET /users/:username/projects": { + parameters: ProjectsListForUserEndpoint; + request: ProjectsListForUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/events/#list-events-received-by-the-authenticated-user + */ + "GET /users/:username/received_events": { + parameters: ActivityListReceivedEventsForUserEndpoint; + request: ActivityListReceivedEventsForUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/events/#list-public-events-received-by-a-user + */ + "GET /users/:username/received_events/public": { + parameters: ActivityListReceivedPublicEventsForUserEndpoint; + request: ActivityListReceivedPublicEventsForUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/#list-repositories-for-a-user + */ + "GET /users/:username/repos": { + parameters: ReposListForUserEndpoint; + request: ReposListForUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/starring/#list-repositories-starred-by-a-user + */ + "GET /users/:username/starred": { + parameters: ActivityListReposStarredByUserEndpoint; + request: ActivityListReposStarredByUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/watching/#list-repositories-watched-by-a-user + */ + "GET /users/:username/subscriptions": { + parameters: ActivityListReposWatchedByUserEndpoint; + request: ActivityListReposWatchedByUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/oauth_applications/#reset-a-token + */ + "PATCH /applications/:client_id/token": { + parameters: AppsResetTokenEndpoint; + request: AppsResetTokenRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/oauth_authorizations/#update-an-existing-authorization + */ + "PATCH /authorizations/:authorization_id": { + parameters: OauthAuthorizationsUpdateAuthorizationEndpoint; + request: OauthAuthorizationsUpdateAuthorizationRequestOptions; + response: OctokitResponse< + OauthAuthorizationsUpdateAuthorizationResponseData + >; + }; + /** + * @see https://developer.github.com/v3/gists/#update-a-gist + */ + "PATCH /gists/:gist_id": { + parameters: GistsUpdateEndpoint; + request: GistsUpdateRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/gists/comments/#edit-a-comment + */ + "PATCH /gists/:gist_id/comments/:comment_id": { + parameters: GistsUpdateCommentEndpoint; + request: GistsUpdateCommentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/notifications/#mark-a-thread-as-read + */ + "PATCH /notifications/threads/:thread_id": { + parameters: ActivityMarkThreadAsReadEndpoint; + request: ActivityMarkThreadAsReadRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/#edit-an-organization + */ + "PATCH /orgs/:org": { + parameters: OrgsUpdateEndpoint; + request: OrgsUpdateRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/hooks/#edit-a-hook + */ + "PATCH /orgs/:org/hooks/:hook_id": { + parameters: OrgsUpdateHookEndpoint; + request: OrgsUpdateHookRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/#edit-team + */ + "PATCH /orgs/:org/teams/:team_slug": { + parameters: TeamsUpdateInOrgEndpoint; + request: TeamsUpdateInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/discussions/#edit-a-discussion + */ + "PATCH /orgs/:org/teams/:team_slug/discussions/:discussion_number": { + parameters: TeamsUpdateDiscussionInOrgEndpoint; + request: TeamsUpdateDiscussionInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/discussion_comments/#edit-a-comment + */ + "PATCH /orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number": { + parameters: TeamsUpdateDiscussionCommentInOrgEndpoint; + request: TeamsUpdateDiscussionCommentInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/team_sync/#create-or-update-idp-group-connections + */ + "PATCH /orgs/:org/teams/:team_slug/team-sync/group-mappings": { + parameters: TeamsCreateOrUpdateIdPGroupConnectionsInOrgEndpoint; + request: TeamsCreateOrUpdateIdPGroupConnectionsInOrgRequestOptions; + response: OctokitResponse< + TeamsCreateOrUpdateIdPGroupConnectionsInOrgResponseData + >; + }; + /** + * @see https://developer.github.com/v3/projects/#update-a-project + */ + "PATCH /projects/:project_id": { + parameters: ProjectsUpdateEndpoint; + request: ProjectsUpdateRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/projects/columns/#update-a-project-column + */ + "PATCH /projects/columns/:column_id": { + parameters: ProjectsUpdateColumnEndpoint; + request: ProjectsUpdateColumnRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/projects/cards/#update-a-project-card + */ + "PATCH /projects/columns/cards/:card_id": { + parameters: ProjectsUpdateCardEndpoint; + request: ProjectsUpdateCardRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/#update-a-repository + */ + "PATCH /repos/:owner/:repo": { + parameters: ReposUpdateEndpoint; + request: ReposUpdateRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#update-pull-request-review-enforcement-of-protected-branch + */ + "PATCH /repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews": { + parameters: ReposUpdateProtectedBranchPullRequestReviewEnforcementEndpoint; + request: ReposUpdateProtectedBranchPullRequestReviewEnforcementRequestOptions; + response: OctokitResponse< + ReposUpdateProtectedBranchPullRequestReviewEnforcementResponseData + >; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#update-required-status-checks-of-protected-branch + */ + "PATCH /repos/:owner/:repo/branches/:branch/protection/required_status_checks": { + parameters: ReposUpdateProtectedBranchRequiredStatusChecksEndpoint; + request: ReposUpdateProtectedBranchRequiredStatusChecksRequestOptions; + response: OctokitResponse< + ReposUpdateProtectedBranchRequiredStatusChecksResponseData + >; + }; + /** + * @see https://developer.github.com/v3/checks/runs/#update-a-check-run + */ + "PATCH /repos/:owner/:repo/check-runs/:check_run_id": { + parameters: ChecksUpdateEndpoint; + request: ChecksUpdateRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/checks/suites/#update-repository-preferences-for-check-suites + */ + "PATCH /repos/:owner/:repo/check-suites/preferences": { + parameters: ChecksSetSuitesPreferencesEndpoint; + request: ChecksSetSuitesPreferencesRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/comments/#update-a-commit-comment + */ + "PATCH /repos/:owner/:repo/comments/:comment_id": { + parameters: ReposUpdateCommitCommentEndpoint; + request: ReposUpdateCommitCommentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/git/refs/#update-a-reference + */ + "PATCH /repos/:owner/:repo/git/refs/:ref": { + parameters: GitUpdateRefEndpoint; + request: GitUpdateRefRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/hooks/#edit-a-hook + */ + "PATCH /repos/:owner/:repo/hooks/:hook_id": { + parameters: ReposUpdateHookEndpoint; + request: ReposUpdateHookRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/migrations/source_imports/#update-existing-import + */ + "PATCH /repos/:owner/:repo/import": { + parameters: MigrationsUpdateImportEndpoint; + request: MigrationsUpdateImportRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/migrations/source_imports/#map-a-commit-author + */ + "PATCH /repos/:owner/:repo/import/authors/:author_id": { + parameters: MigrationsMapCommitAuthorEndpoint; + request: MigrationsMapCommitAuthorRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/migrations/source_imports/#set-git-lfs-preference + */ + "PATCH /repos/:owner/:repo/import/lfs": { + parameters: MigrationsSetLfsPreferenceEndpoint; + request: MigrationsSetLfsPreferenceRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/invitations/#update-a-repository-invitation + */ + "PATCH /repos/:owner/:repo/invitations/:invitation_id": { + parameters: ReposUpdateInvitationEndpoint; + request: ReposUpdateInvitationRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/#update-an-issue + */ + "PATCH /repos/:owner/:repo/issues/:issue_number": { + parameters: IssuesUpdateEndpoint; + request: IssuesUpdateRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/comments/#edit-a-comment + */ + "PATCH /repos/:owner/:repo/issues/comments/:comment_id": { + parameters: IssuesUpdateCommentEndpoint; + request: IssuesUpdateCommentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/labels/#update-a-label + */ + "PATCH /repos/:owner/:repo/labels/:name": { + parameters: IssuesUpdateLabelEndpoint; + request: IssuesUpdateLabelRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/milestones/#update-a-milestone + */ + "PATCH /repos/:owner/:repo/milestones/:milestone_number": { + parameters: IssuesUpdateMilestoneEndpoint; + request: IssuesUpdateMilestoneRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/pulls/#update-a-pull-request + */ + "PATCH /repos/:owner/:repo/pulls/:pull_number": { + parameters: PullsUpdateEndpoint; + request: PullsUpdateRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/pulls/comments/#edit-a-comment + */ + "PATCH /repos/:owner/:repo/pulls/comments/:comment_id": { + parameters: PullsUpdateCommentEndpoint; + request: PullsUpdateCommentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/releases/#edit-a-release + */ + "PATCH /repos/:owner/:repo/releases/:release_id": { + parameters: ReposUpdateReleaseEndpoint; + request: ReposUpdateReleaseRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/releases/#edit-a-release-asset + */ + "PATCH /repos/:owner/:repo/releases/assets/:asset_id": { + parameters: ReposUpdateReleaseAssetEndpoint; + request: ReposUpdateReleaseAssetRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/scim/#update-a-user-attribute + */ + "PATCH /scim/v2/organizations/:org/Users/:scim_user_id": { + parameters: ScimUpdateUserAttributeEndpoint; + request: ScimUpdateUserAttributeRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/#edit-team-legacy + */ + "PATCH /teams/:team_id": { + parameters: TeamsUpdateLegacyEndpoint; + request: TeamsUpdateLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/discussions/#edit-a-discussion-legacy + */ + "PATCH /teams/:team_id/discussions/:discussion_number": { + parameters: TeamsUpdateDiscussionLegacyEndpoint; + request: TeamsUpdateDiscussionLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/discussion_comments/#edit-a-comment-legacy + */ + "PATCH /teams/:team_id/discussions/:discussion_number/comments/:comment_number": { + parameters: TeamsUpdateDiscussionCommentLegacyEndpoint; + request: TeamsUpdateDiscussionCommentLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/team_sync/#create-or-update-idp-group-connections-legacy + */ + "PATCH /teams/:team_id/team-sync/group-mappings": { + parameters: TeamsCreateOrUpdateIdPGroupConnectionsLegacyEndpoint; + request: TeamsCreateOrUpdateIdPGroupConnectionsLegacyRequestOptions; + response: OctokitResponse< + TeamsCreateOrUpdateIdPGroupConnectionsLegacyResponseData + >; + }; + /** + * @see https://developer.github.com/v3/users/#update-the-authenticated-user + */ + "PATCH /user": { + parameters: UsersUpdateAuthenticatedEndpoint; + request: UsersUpdateAuthenticatedRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/emails/#toggle-primary-email-visibility + */ + "PATCH /user/email/visibility": { + parameters: UsersTogglePrimaryEmailVisibilityEndpoint; + request: UsersTogglePrimaryEmailVisibilityRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/members/#edit-your-organization-membership + */ + "PATCH /user/memberships/orgs/:org": { + parameters: OrgsUpdateMembershipEndpoint; + request: OrgsUpdateMembershipRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/invitations/#accept-a-repository-invitation + */ + "PATCH /user/repository_invitations/:invitation_id": { + parameters: ReposAcceptInvitationEndpoint; + request: ReposAcceptInvitationRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/#create-a-github-app-from-a-manifest + */ + "POST /app-manifests/:code/conversions": { + parameters: AppsCreateFromManifestEndpoint; + request: AppsCreateFromManifestRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/#create-a-new-installation-token + */ + "POST /app/installations/:installation_id/access_tokens": { + parameters: AppsCreateInstallationTokenEndpoint; + request: AppsCreateInstallationTokenRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/oauth_applications/#check-a-token + */ + "POST /applications/:client_id/token": { + parameters: AppsCheckTokenEndpoint; + request: AppsCheckTokenRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/oauth_applications/#reset-an-authorization + */ + "POST /applications/:client_id/tokens/:access_token": { + parameters: AppsResetAuthorizationEndpoint; + request: AppsResetAuthorizationRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/oauth_authorizations/#create-a-new-authorization + */ + "POST /authorizations": { + parameters: OauthAuthorizationsCreateAuthorizationEndpoint; + request: OauthAuthorizationsCreateAuthorizationRequestOptions; + response: OctokitResponse< + OauthAuthorizationsCreateAuthorizationResponseData + >; + }; + /** + * @see https://developer.github.com/v3/apps/installations/#create-a-content-attachment + */ + "POST /content_references/:content_reference_id/attachments": { + parameters: AppsCreateContentAttachmentEndpoint; + request: AppsCreateContentAttachmentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/gists/#create-a-gist + */ + "POST /gists": { + parameters: GistsCreateEndpoint; + request: GistsCreateRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/gists/comments/#create-a-comment + */ + "POST /gists/:gist_id/comments": { + parameters: GistsCreateCommentEndpoint; + request: GistsCreateCommentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/gists/#fork-a-gist + */ + "POST /gists/:gist_id/forks": { + parameters: GistsForkEndpoint; + request: GistsForkRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/markdown/#render-an-arbitrary-markdown-document + */ + "POST /markdown": { + parameters: MarkdownRenderEndpoint; + request: MarkdownRenderRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/markdown/#render-a-markdown-document-in-raw-mode + */ + "POST /markdown/raw": { + parameters: MarkdownRenderRawEndpoint; + request: MarkdownRenderRawRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/self-hosted-runners/#create-a-registration-token-for-an-organization + */ + "POST /orgs/:org/actions/runners/registration-token": { + parameters: ActionsCreateRegistrationTokenForOrgEndpoint; + request: ActionsCreateRegistrationTokenForOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/self-hosted-runners/#create-a-remove-token-for-an-organization + */ + "POST /orgs/:org/actions/runners/remove-token": { + parameters: ActionsCreateRemoveTokenForOrgEndpoint; + request: ActionsCreateRemoveTokenForOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/hooks/#create-a-hook + */ + "POST /orgs/:org/hooks": { + parameters: OrgsCreateHookEndpoint; + request: OrgsCreateHookRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/hooks/#ping-a-hook + */ + "POST /orgs/:org/hooks/:hook_id/pings": { + parameters: OrgsPingHookEndpoint; + request: OrgsPingHookRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/members/#create-organization-invitation + */ + "POST /orgs/:org/invitations": { + parameters: OrgsCreateInvitationEndpoint; + request: OrgsCreateInvitationRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/migrations/orgs/#start-an-organization-migration + */ + "POST /orgs/:org/migrations": { + parameters: MigrationsStartForOrgEndpoint; + request: MigrationsStartForOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/projects/#create-an-organization-project + */ + "POST /orgs/:org/projects": { + parameters: ProjectsCreateForOrgEndpoint; + request: ProjectsCreateForOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/#create-an-organization-repository + */ + "POST /orgs/:org/repos": { + parameters: ReposCreateInOrgEndpoint; + request: ReposCreateInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/#create-team + */ + "POST /orgs/:org/teams": { + parameters: TeamsCreateEndpoint; + request: TeamsCreateRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/discussions/#create-a-discussion + */ + "POST /orgs/:org/teams/:team_slug/discussions": { + parameters: TeamsCreateDiscussionInOrgEndpoint; + request: TeamsCreateDiscussionInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/discussion_comments/#create-a-comment + */ + "POST /orgs/:org/teams/:team_slug/discussions/:discussion_number/comments": { + parameters: TeamsCreateDiscussionCommentInOrgEndpoint; + request: TeamsCreateDiscussionCommentInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/reactions/#create-reaction-for-a-team-discussion-comment + */ + "POST /orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number/reactions": { + parameters: ReactionsCreateForTeamDiscussionCommentInOrgEndpoint; + request: ReactionsCreateForTeamDiscussionCommentInOrgRequestOptions; + response: OctokitResponse< + ReactionsCreateForTeamDiscussionCommentInOrgResponseData + >; + }; + /** + * @see https://developer.github.com/v3/reactions/#create-reaction-for-a-team-discussion + */ + "POST /orgs/:org/teams/:team_slug/discussions/:discussion_number/reactions": { + parameters: ReactionsCreateForTeamDiscussionInOrgEndpoint; + request: ReactionsCreateForTeamDiscussionInOrgRequestOptions; + response: OctokitResponse< + ReactionsCreateForTeamDiscussionInOrgResponseData + >; + }; + /** + * @see https://developer.github.com/v3/projects/columns/#create-a-project-column + */ + "POST /projects/:project_id/columns": { + parameters: ProjectsCreateColumnEndpoint; + request: ProjectsCreateColumnRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/projects/cards/#create-a-project-card + */ + "POST /projects/columns/:column_id/cards": { + parameters: ProjectsCreateCardEndpoint; + request: ProjectsCreateCardRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/projects/columns/#move-a-project-column + */ + "POST /projects/columns/:column_id/moves": { + parameters: ProjectsMoveColumnEndpoint; + request: ProjectsMoveColumnRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/projects/cards/#move-a-project-card + */ + "POST /projects/columns/cards/:card_id/moves": { + parameters: ProjectsMoveCardEndpoint; + request: ProjectsMoveCardRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/self-hosted-runners/#create-a-registration-token-for-a-repository + */ + "POST /repos/:owner/:repo/actions/runners/registration-token": { + parameters: ActionsCreateRegistrationTokenForRepoEndpoint; + request: ActionsCreateRegistrationTokenForRepoRequestOptions; + response: OctokitResponse< + ActionsCreateRegistrationTokenForRepoResponseData + >; + }; + /** + * @see https://developer.github.com/v3/actions/self-hosted-runners/#create-a-remove-token-for-a-repository + */ + "POST /repos/:owner/:repo/actions/runners/remove-token": { + parameters: ActionsCreateRemoveTokenForRepoEndpoint; + request: ActionsCreateRemoveTokenForRepoRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/workflow-runs/#cancel-a-workflow-run + */ + "POST /repos/:owner/:repo/actions/runs/:run_id/cancel": { + parameters: ActionsCancelWorkflowRunEndpoint; + request: ActionsCancelWorkflowRunRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/workflow-runs/#re-run-a-workflow + */ + "POST /repos/:owner/:repo/actions/runs/:run_id/rerun": { + parameters: ActionsReRunWorkflowEndpoint; + request: ActionsReRunWorkflowRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#add-admin-enforcement-of-protected-branch + */ + "POST /repos/:owner/:repo/branches/:branch/protection/enforce_admins": { + parameters: ReposAddProtectedBranchAdminEnforcementEndpoint; + request: ReposAddProtectedBranchAdminEnforcementRequestOptions; + response: OctokitResponse< + ReposAddProtectedBranchAdminEnforcementResponseData + >; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#add-required-signatures-of-protected-branch + */ + "POST /repos/:owner/:repo/branches/:branch/protection/required_signatures": { + parameters: ReposAddProtectedBranchRequiredSignaturesEndpoint; + request: ReposAddProtectedBranchRequiredSignaturesRequestOptions; + response: OctokitResponse< + ReposAddProtectedBranchRequiredSignaturesResponseData + >; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#add-required-status-checks-contexts-of-protected-branch + */ + "POST /repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts": { + parameters: ReposAddProtectedBranchRequiredStatusChecksContextsEndpoint; + request: ReposAddProtectedBranchRequiredStatusChecksContextsRequestOptions; + response: OctokitResponse< + ReposAddProtectedBranchRequiredStatusChecksContextsResponseData + >; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#add-app-restrictions-of-protected-branch + */ + "POST /repos/:owner/:repo/branches/:branch/protection/restrictions/apps": { + parameters: ReposAddProtectedBranchAppRestrictionsEndpoint; + request: ReposAddProtectedBranchAppRestrictionsRequestOptions; + response: OctokitResponse< + ReposAddProtectedBranchAppRestrictionsResponseData + >; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#add-team-restrictions-of-protected-branch + */ + "POST /repos/:owner/:repo/branches/:branch/protection/restrictions/teams": { + parameters: ReposAddProtectedBranchTeamRestrictionsEndpoint; + request: ReposAddProtectedBranchTeamRestrictionsRequestOptions; + response: OctokitResponse< + ReposAddProtectedBranchTeamRestrictionsResponseData + >; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#add-user-restrictions-of-protected-branch + */ + "POST /repos/:owner/:repo/branches/:branch/protection/restrictions/users": { + parameters: ReposAddProtectedBranchUserRestrictionsEndpoint; + request: ReposAddProtectedBranchUserRestrictionsRequestOptions; + response: OctokitResponse< + ReposAddProtectedBranchUserRestrictionsResponseData + >; + }; + /** + * @see https://developer.github.com/v3/checks/runs/#create-a-check-run + */ + "POST /repos/:owner/:repo/check-runs": { + parameters: ChecksCreateEndpoint; + request: ChecksCreateRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/checks/suites/#create-a-check-suite + */ + "POST /repos/:owner/:repo/check-suites": { + parameters: ChecksCreateSuiteEndpoint; + request: ChecksCreateSuiteRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/checks/suites/#rerequest-a-check-suite + */ + "POST /repos/:owner/:repo/check-suites/:check_suite_id/rerequest": { + parameters: ChecksRerequestSuiteEndpoint; + request: ChecksRerequestSuiteRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/reactions/#create-reaction-for-a-commit-comment + */ + "POST /repos/:owner/:repo/comments/:comment_id/reactions": { + parameters: ReactionsCreateForCommitCommentEndpoint; + request: ReactionsCreateForCommitCommentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/comments/#create-a-commit-comment + */ + "POST /repos/:owner/:repo/commits/:commit_sha/comments": { + parameters: ReposCreateCommitCommentEndpoint; + request: ReposCreateCommitCommentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/deployments/#create-a-deployment + */ + "POST /repos/:owner/:repo/deployments": { + parameters: ReposCreateDeploymentEndpoint; + request: ReposCreateDeploymentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/deployments/#create-a-deployment-status + */ + "POST /repos/:owner/:repo/deployments/:deployment_id/statuses": { + parameters: ReposCreateDeploymentStatusEndpoint; + request: ReposCreateDeploymentStatusRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/#create-a-repository-dispatch-event + */ + "POST /repos/:owner/:repo/dispatches": { + parameters: ReposCreateDispatchEventEndpoint; + request: ReposCreateDispatchEventRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/forks/#create-a-fork + */ + "POST /repos/:owner/:repo/forks": { + parameters: ReposCreateForkEndpoint; + request: ReposCreateForkRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/git/blobs/#create-a-blob + */ + "POST /repos/:owner/:repo/git/blobs": { + parameters: GitCreateBlobEndpoint; + request: GitCreateBlobRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/git/commits/#create-a-commit + */ + "POST /repos/:owner/:repo/git/commits": { + parameters: GitCreateCommitEndpoint; + request: GitCreateCommitRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/git/refs/#create-a-reference + */ + "POST /repos/:owner/:repo/git/refs": { + parameters: GitCreateRefEndpoint; + request: GitCreateRefRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/git/tags/#create-a-tag-object + */ + "POST /repos/:owner/:repo/git/tags": { + parameters: GitCreateTagEndpoint; + request: GitCreateTagRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/git/trees/#create-a-tree + */ + "POST /repos/:owner/:repo/git/trees": { + parameters: GitCreateTreeEndpoint; + request: GitCreateTreeRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/hooks/#create-a-hook + */ + "POST /repos/:owner/:repo/hooks": { + parameters: ReposCreateHookEndpoint; + request: ReposCreateHookRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/hooks/#ping-a-hook + */ + "POST /repos/:owner/:repo/hooks/:hook_id/pings": { + parameters: ReposPingHookEndpoint; + request: ReposPingHookRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/hooks/#test-a-push-hook + */ + "POST /repos/:owner/:repo/hooks/:hook_id/tests": { + parameters: ReposTestPushHookEndpoint; + request: ReposTestPushHookRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/#create-an-issue + */ + "POST /repos/:owner/:repo/issues": { + parameters: IssuesCreateEndpoint; + request: IssuesCreateRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/assignees/#add-assignees-to-an-issue + */ + "POST /repos/:owner/:repo/issues/:issue_number/assignees": { + parameters: IssuesAddAssigneesEndpoint; + request: IssuesAddAssigneesRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/comments/#create-a-comment + */ + "POST /repos/:owner/:repo/issues/:issue_number/comments": { + parameters: IssuesCreateCommentEndpoint; + request: IssuesCreateCommentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/labels/#add-labels-to-an-issue + */ + "POST /repos/:owner/:repo/issues/:issue_number/labels": { + parameters: IssuesAddLabelsEndpoint; + request: IssuesAddLabelsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/reactions/#create-reaction-for-an-issue + */ + "POST /repos/:owner/:repo/issues/:issue_number/reactions": { + parameters: ReactionsCreateForIssueEndpoint; + request: ReactionsCreateForIssueRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/reactions/#create-reaction-for-an-issue-comment + */ + "POST /repos/:owner/:repo/issues/comments/:comment_id/reactions": { + parameters: ReactionsCreateForIssueCommentEndpoint; + request: ReactionsCreateForIssueCommentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/keys/#add-a-new-deploy-key + */ + "POST /repos/:owner/:repo/keys": { + parameters: ReposAddDeployKeyEndpoint; + request: ReposAddDeployKeyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/labels/#create-a-label + */ + "POST /repos/:owner/:repo/labels": { + parameters: IssuesCreateLabelEndpoint; + request: IssuesCreateLabelRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/merging/#perform-a-merge + */ + "POST /repos/:owner/:repo/merges": { + parameters: ReposMergeEndpoint; + request: ReposMergeRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/milestones/#create-a-milestone + */ + "POST /repos/:owner/:repo/milestones": { + parameters: IssuesCreateMilestoneEndpoint; + request: IssuesCreateMilestoneRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/pages/#enable-a-pages-site + */ + "POST /repos/:owner/:repo/pages": { + parameters: ReposEnablePagesSiteEndpoint; + request: ReposEnablePagesSiteRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/pages/#request-a-page-build + */ + "POST /repos/:owner/:repo/pages/builds": { + parameters: ReposRequestPageBuildEndpoint; + request: ReposRequestPageBuildRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/projects/#create-a-repository-project + */ + "POST /repos/:owner/:repo/projects": { + parameters: ProjectsCreateForRepoEndpoint; + request: ProjectsCreateForRepoRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/pulls/#create-a-pull-request + */ + "POST /repos/:owner/:repo/pulls": { + parameters: PullsCreateEndpoint; + request: PullsCreateRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/pulls/comments/#create-a-comment + */ + "POST /repos/:owner/:repo/pulls/:pull_number/comments": { + parameters: PullsCreateCommentEndpoint; + request: PullsCreateCommentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/pulls/comments/#create-a-review-comment-reply + */ + "POST /repos/:owner/:repo/pulls/:pull_number/comments/:comment_id/replies": { + parameters: PullsCreateReviewCommentReplyEndpoint; + request: PullsCreateReviewCommentReplyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/pulls/review_requests/#create-a-review-request + */ + "POST /repos/:owner/:repo/pulls/:pull_number/requested_reviewers": { + parameters: PullsCreateReviewRequestEndpoint; + request: PullsCreateReviewRequestRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/pulls/reviews/#create-a-pull-request-review + */ + "POST /repos/:owner/:repo/pulls/:pull_number/reviews": { + parameters: PullsCreateReviewEndpoint; + request: PullsCreateReviewRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/pulls/reviews/#submit-a-pull-request-review + */ + "POST /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/events": { + parameters: PullsSubmitReviewEndpoint; + request: PullsSubmitReviewRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/reactions/#create-reaction-for-a-pull-request-review-comment + */ + "POST /repos/:owner/:repo/pulls/comments/:comment_id/reactions": { + parameters: ReactionsCreateForPullRequestReviewCommentEndpoint; + request: ReactionsCreateForPullRequestReviewCommentRequestOptions; + response: OctokitResponse< + ReactionsCreateForPullRequestReviewCommentResponseData + >; + }; + /** + * @see https://developer.github.com/v3/repos/releases/#create-a-release + */ + "POST /repos/:owner/:repo/releases": { + parameters: ReposCreateReleaseEndpoint; + request: ReposCreateReleaseRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/releases/#upload-a-release-asset + */ + "POST /repos/:owner/:repo/releases/:release_id/assets{?name,label}": { + parameters: ReposUploadReleaseAssetEndpoint; + request: ReposUploadReleaseAssetRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/statuses/#create-a-status + */ + "POST /repos/:owner/:repo/statuses/:sha": { + parameters: ReposCreateStatusEndpoint; + request: ReposCreateStatusRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/#transfer-a-repository + */ + "POST /repos/:owner/:repo/transfer": { + parameters: ReposTransferEndpoint; + request: ReposTransferRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/#create-a-repository-using-a-template + */ + "POST /repos/:template_owner/:template_repo/generate": { + parameters: ReposCreateUsingTemplateEndpoint; + request: ReposCreateUsingTemplateRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/scim/#provision-and-invite-users + */ + "POST /scim/v2/organizations/:org/Users": { + parameters: ScimProvisionAndInviteUsersEndpoint; + request: ScimProvisionAndInviteUsersRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/discussions/#create-a-discussion-legacy + */ + "POST /teams/:team_id/discussions": { + parameters: TeamsCreateDiscussionLegacyEndpoint; + request: TeamsCreateDiscussionLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/discussion_comments/#create-a-comment-legacy + */ + "POST /teams/:team_id/discussions/:discussion_number/comments": { + parameters: TeamsCreateDiscussionCommentLegacyEndpoint; + request: TeamsCreateDiscussionCommentLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/reactions/#create-reaction-for-a-team-discussion-comment-legacy + */ + "POST /teams/:team_id/discussions/:discussion_number/comments/:comment_number/reactions": { + parameters: ReactionsCreateForTeamDiscussionCommentLegacyEndpoint; + request: ReactionsCreateForTeamDiscussionCommentLegacyRequestOptions; + response: OctokitResponse< + ReactionsCreateForTeamDiscussionCommentLegacyResponseData + >; + }; + /** + * @see https://developer.github.com/v3/reactions/#create-reaction-for-a-team-discussion-legacy + */ + "POST /teams/:team_id/discussions/:discussion_number/reactions": { + parameters: ReactionsCreateForTeamDiscussionLegacyEndpoint; + request: ReactionsCreateForTeamDiscussionLegacyRequestOptions; + response: OctokitResponse< + ReactionsCreateForTeamDiscussionLegacyResponseData + >; + }; + /** + * @see https://developer.github.com/v3/users/emails/#add-email-addresses + */ + "POST /user/emails": { + parameters: UsersAddEmailsEndpoint; + request: UsersAddEmailsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/gpg_keys/#create-a-gpg-key + */ + "POST /user/gpg_keys": { + parameters: UsersCreateGpgKeyEndpoint; + request: UsersCreateGpgKeyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/keys/#create-a-public-key + */ + "POST /user/keys": { + parameters: UsersCreatePublicKeyEndpoint; + request: UsersCreatePublicKeyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/migrations/users/#start-a-user-migration + */ + "POST /user/migrations": { + parameters: MigrationsStartForAuthenticatedUserEndpoint; + request: MigrationsStartForAuthenticatedUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/projects/#create-a-user-project + */ + "POST /user/projects": { + parameters: ProjectsCreateForAuthenticatedUserEndpoint; + request: ProjectsCreateForAuthenticatedUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/#create-a-repository-for-the-authenticated-user + */ + "POST /user/repos": { + parameters: ReposCreateForAuthenticatedUserEndpoint; + request: ReposCreateForAuthenticatedUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/#suspend-an-installation + */ + "PUT /app/installations/:installation_id/suspended": { + parameters: AppsSuspendInstallationEndpoint; + request: AppsSuspendInstallationRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/oauth_authorizations/#get-or-create-an-authorization-for-a-specific-app + */ + "PUT /authorizations/clients/:client_id": { + parameters: OauthAuthorizationsGetOrCreateAuthorizationForAppEndpoint; + request: OauthAuthorizationsGetOrCreateAuthorizationForAppRequestOptions; + response: OctokitResponse< + OauthAuthorizationsGetOrCreateAuthorizationForAppResponseData + >; + }; + /** + * @see https://developer.github.com/v3/oauth_authorizations/#get-or-create-an-authorization-for-a-specific-app-and-fingerprint + */ + "PUT /authorizations/clients/:client_id/:fingerprint": { + parameters: OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintEndpoint; + request: OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintRequestOptions; + response: OctokitResponse< + OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintResponseData + >; + }; + /** + * @see https://developer.github.com/v3/gists/#star-a-gist + */ + "PUT /gists/:gist_id/star": { + parameters: GistsStarEndpoint; + request: GistsStarRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/notifications/#mark-notifications-as-read + */ + "PUT /notifications": { + parameters: ActivityMarkNotificationsAsReadEndpoint; + request: ActivityMarkNotificationsAsReadRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/notifications/#set-a-thread-subscription + */ + "PUT /notifications/threads/:thread_id/subscription": { + parameters: ActivitySetThreadSubscriptionEndpoint; + request: ActivitySetThreadSubscriptionRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/blocking/#block-a-user + */ + "PUT /orgs/:org/blocks/:username": { + parameters: OrgsBlockUserEndpoint; + request: OrgsBlockUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/interactions/orgs/#add-or-update-interaction-restrictions-for-an-organization + */ + "PUT /orgs/:org/interaction-limits": { + parameters: InteractionsAddOrUpdateRestrictionsForOrgEndpoint; + request: InteractionsAddOrUpdateRestrictionsForOrgRequestOptions; + response: OctokitResponse< + InteractionsAddOrUpdateRestrictionsForOrgResponseData + >; + }; + /** + * @see https://developer.github.com/v3/orgs/members/#add-or-update-organization-membership + */ + "PUT /orgs/:org/memberships/:username": { + parameters: OrgsAddOrUpdateMembershipEndpoint; + request: OrgsAddOrUpdateMembershipRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/outside_collaborators/#convert-member-to-outside-collaborator + */ + "PUT /orgs/:org/outside_collaborators/:username": { + parameters: OrgsConvertMemberToOutsideCollaboratorEndpoint; + request: OrgsConvertMemberToOutsideCollaboratorRequestOptions; + response: OctokitResponse< + OrgsConvertMemberToOutsideCollaboratorResponseData + >; + }; + /** + * @see https://developer.github.com/v3/orgs/members/#publicize-a-users-membership + */ + "PUT /orgs/:org/public_members/:username": { + parameters: OrgsPublicizeMembershipEndpoint; + request: OrgsPublicizeMembershipRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/members/#add-or-update-team-membership + */ + "PUT /orgs/:org/teams/:team_slug/memberships/:username": { + parameters: TeamsAddOrUpdateMembershipInOrgEndpoint; + request: TeamsAddOrUpdateMembershipInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/#add-or-update-team-project + */ + "PUT /orgs/:org/teams/:team_slug/projects/:project_id": { + parameters: TeamsAddOrUpdateProjectInOrgEndpoint; + request: TeamsAddOrUpdateProjectInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/#add-or-update-team-repository + */ + "PUT /orgs/:org/teams/:team_slug/repos/:owner/:repo": { + parameters: TeamsAddOrUpdateRepoInOrgEndpoint; + request: TeamsAddOrUpdateRepoInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/projects/collaborators/#add-user-as-a-collaborator + */ + "PUT /projects/:project_id/collaborators/:username": { + parameters: ProjectsAddCollaboratorEndpoint; + request: ProjectsAddCollaboratorRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/secrets/#create-or-update-a-secret-for-a-repository + */ + "PUT /repos/:owner/:repo/actions/secrets/:name": { + parameters: ActionsCreateOrUpdateSecretForRepoEndpoint; + request: ActionsCreateOrUpdateSecretForRepoRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/#enable-automated-security-fixes + */ + "PUT /repos/:owner/:repo/automated-security-fixes": { + parameters: ReposEnableAutomatedSecurityFixesEndpoint; + request: ReposEnableAutomatedSecurityFixesRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#update-branch-protection + */ + "PUT /repos/:owner/:repo/branches/:branch/protection": { + parameters: ReposUpdateBranchProtectionEndpoint; + request: ReposUpdateBranchProtectionRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#replace-required-status-checks-contexts-of-protected-branch + */ + "PUT /repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts": { + parameters: ReposReplaceProtectedBranchRequiredStatusChecksContextsEndpoint; + request: ReposReplaceProtectedBranchRequiredStatusChecksContextsRequestOptions; + response: OctokitResponse< + ReposReplaceProtectedBranchRequiredStatusChecksContextsResponseData + >; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#replace-app-restrictions-of-protected-branch + */ + "PUT /repos/:owner/:repo/branches/:branch/protection/restrictions/apps": { + parameters: ReposReplaceProtectedBranchAppRestrictionsEndpoint; + request: ReposReplaceProtectedBranchAppRestrictionsRequestOptions; + response: OctokitResponse< + ReposReplaceProtectedBranchAppRestrictionsResponseData + >; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#replace-team-restrictions-of-protected-branch + */ + "PUT /repos/:owner/:repo/branches/:branch/protection/restrictions/teams": { + parameters: ReposReplaceProtectedBranchTeamRestrictionsEndpoint; + request: ReposReplaceProtectedBranchTeamRestrictionsRequestOptions; + response: OctokitResponse< + ReposReplaceProtectedBranchTeamRestrictionsResponseData + >; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#replace-user-restrictions-of-protected-branch + */ + "PUT /repos/:owner/:repo/branches/:branch/protection/restrictions/users": { + parameters: ReposReplaceProtectedBranchUserRestrictionsEndpoint; + request: ReposReplaceProtectedBranchUserRestrictionsRequestOptions; + response: OctokitResponse< + ReposReplaceProtectedBranchUserRestrictionsResponseData + >; + }; + /** + * @see https://developer.github.com/v3/repos/collaborators/#add-user-as-a-collaborator + */ + "PUT /repos/:owner/:repo/collaborators/:username": { + parameters: ReposAddCollaboratorEndpoint; + request: ReposAddCollaboratorRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/contents/#create-or-update-a-file + */ + "PUT /repos/:owner/:repo/contents/:path": { + parameters: ReposCreateOrUpdateFileEndpoint; + request: ReposCreateOrUpdateFileRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/migrations/source_imports/#start-an-import + */ + "PUT /repos/:owner/:repo/import": { + parameters: MigrationsStartImportEndpoint; + request: MigrationsStartImportRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/interactions/repos/#add-or-update-interaction-restrictions-for-a-repository + */ + "PUT /repos/:owner/:repo/interaction-limits": { + parameters: InteractionsAddOrUpdateRestrictionsForRepoEndpoint; + request: InteractionsAddOrUpdateRestrictionsForRepoRequestOptions; + response: OctokitResponse< + InteractionsAddOrUpdateRestrictionsForRepoResponseData + >; + }; + /** + * @see https://developer.github.com/v3/issues/labels/#replace-all-labels-for-an-issue + */ + "PUT /repos/:owner/:repo/issues/:issue_number/labels": { + parameters: IssuesReplaceAllLabelsEndpoint; + request: IssuesReplaceAllLabelsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/#lock-an-issue + */ + "PUT /repos/:owner/:repo/issues/:issue_number/lock": { + parameters: IssuesLockEndpoint; + request: IssuesLockRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/notifications/#mark-repository-notifications-as-read + */ + "PUT /repos/:owner/:repo/notifications": { + parameters: ActivityMarkRepoNotificationsAsReadEndpoint; + request: ActivityMarkRepoNotificationsAsReadRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/pages/#update-information-about-a-pages-site + */ + "PUT /repos/:owner/:repo/pages": { + parameters: ReposUpdateInformationAboutPagesSiteEndpoint; + request: ReposUpdateInformationAboutPagesSiteRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/pulls/#merge-a-pull-request-merge-button + */ + "PUT /repos/:owner/:repo/pulls/:pull_number/merge": { + parameters: PullsMergeEndpoint; + request: PullsMergeRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/pulls/reviews/#update-a-pull-request-review + */ + "PUT /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id": { + parameters: PullsUpdateReviewEndpoint; + request: PullsUpdateReviewRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/pulls/reviews/#dismiss-a-pull-request-review + */ + "PUT /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/dismissals": { + parameters: PullsDismissReviewEndpoint; + request: PullsDismissReviewRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/pulls/#update-a-pull-request-branch + */ + "PUT /repos/:owner/:repo/pulls/:pull_number/update-branch": { + parameters: PullsUpdateBranchEndpoint; + request: PullsUpdateBranchRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/watching/#set-a-repository-subscription + */ + "PUT /repos/:owner/:repo/subscription": { + parameters: ActivitySetRepoSubscriptionEndpoint; + request: ActivitySetRepoSubscriptionRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/#replace-all-repository-topics + */ + "PUT /repos/:owner/:repo/topics": { + parameters: ReposReplaceAllTopicsEndpoint; + request: ReposReplaceAllTopicsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/#enable-vulnerability-alerts + */ + "PUT /repos/:owner/:repo/vulnerability-alerts": { + parameters: ReposEnableVulnerabilityAlertsEndpoint; + request: ReposEnableVulnerabilityAlertsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/scim/#replace-a-provisioned-users-information + */ + "PUT /scim/v2/organizations/:org/Users/:scim_user_id": { + parameters: ScimReplaceProvisionedUserInformationEndpoint; + request: ScimReplaceProvisionedUserInformationRequestOptions; + response: OctokitResponse< + ScimReplaceProvisionedUserInformationResponseData + >; + }; + /** + * @see https://developer.github.com/v3/teams/members/#add-team-member-legacy + */ + "PUT /teams/:team_id/members/:username": { + parameters: TeamsAddMemberLegacyEndpoint; + request: TeamsAddMemberLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/members/#add-or-update-team-membership-legacy + */ + "PUT /teams/:team_id/memberships/:username": { + parameters: TeamsAddOrUpdateMembershipLegacyEndpoint; + request: TeamsAddOrUpdateMembershipLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/#add-or-update-team-project-legacy + */ + "PUT /teams/:team_id/projects/:project_id": { + parameters: TeamsAddOrUpdateProjectLegacyEndpoint; + request: TeamsAddOrUpdateProjectLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/#add-or-update-team-repository-legacy + */ + "PUT /teams/:team_id/repos/:owner/:repo": { + parameters: TeamsAddOrUpdateRepoLegacyEndpoint; + request: TeamsAddOrUpdateRepoLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/blocking/#block-a-user + */ + "PUT /user/blocks/:username": { + parameters: UsersBlockEndpoint; + request: UsersBlockRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/followers/#follow-a-user + */ + "PUT /user/following/:username": { + parameters: UsersFollowEndpoint; + request: UsersFollowRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/installations/#add-repository-to-installation + */ + "PUT /user/installations/:installation_id/repositories/:repository_id": { + parameters: AppsAddRepoToInstallationEndpoint; + request: AppsAddRepoToInstallationRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/starring/#star-a-repository-for-the-authenticated-user + */ + "PUT /user/starred/:owner/:repo": { + parameters: ActivityStarRepoForAuthenticatedUserEndpoint; + request: ActivityStarRepoForAuthenticatedUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/watching/#watch-a-repository-legacy + */ + "PUT /user/subscriptions/:owner/:repo": { + parameters: ActivityWatchRepoLegacyEndpoint; + request: ActivityWatchRepoLegacyRequestOptions; + response: OctokitResponse; + }; } -type AppsGetAuthenticatedEndpoint = {}; +type AppsGetAuthenticatedEndpoint = {} & RequiredPreview<"machine-man">; + type AppsGetAuthenticatedRequestOptions = { method: "GET"; - url: Url; + url: "/app"; headers: RequestHeaders; request: RequestRequestOptions; }; +type AppsGetAuthenticatedResponseDataPermissions = { + metadata: string; + contents: string; + issues: string; + single_file: string; +}; +type AppsGetAuthenticatedResponseDataOwner = { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; +}; +type AppsGetAuthenticatedResponseData = { + id: number; + slug: string; + node_id: string; + owner: AppsGetAuthenticatedResponseDataOwner; + name: string; + description: string; + external_url: string; + html_url: string; + created_at: string; + updated_at: string; + permissions: AppsGetAuthenticatedResponseDataPermissions; + events: Array; + installations_count: number; +}; + type AppsCreateFromManifestEndpoint = { /** * code parameter */ code: string; }; + type AppsCreateFromManifestRequestOptions = { method: "POST"; - url: Url; + url: "/app-manifests/:code/conversions"; headers: RequestHeaders; request: RequestRequestOptions; }; +type AppsCreateFromManifestResponseDataOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type AppsCreateFromManifestResponseData = { + id: number; + node_id: string; + owner: AppsCreateFromManifestResponseDataOwner; + name: string; + description: null; + external_url: string; + html_url: string; + created_at: string; + updated_at: string; + client_id: string; + client_secret: string; + webhook_secret: string; + pem: string; +}; + type AppsListInstallationsEndpoint = { /** * Results per page (max 100) @@ -2031,37 +5088,114 @@ type AppsListInstallationsEndpoint = { * Page number of the results to fetch. */ page?: number; -}; +} & RequiredPreview<"machine-man">; + type AppsListInstallationsRequestOptions = { method: "GET"; - url: Url; + url: "/app/installations"; headers: RequestHeaders; request: RequestRequestOptions; }; +type AppsListInstallationsResponseDataItemPermissions = { + metadata: string; + contents: string; + issues: string; + single_file: string; +}; +type AppsListInstallationsResponseDataItemAccount = { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; +}; +type AppsListInstallationsResponseDataItem = { + id: number; + account: AppsListInstallationsResponseDataItemAccount; + access_tokens_url: string; + repositories_url: string; + html_url: string; + app_id: number; + target_id: number; + target_type: string; + permissions: AppsListInstallationsResponseDataItemPermissions; + events: Array; + single_file_name: string; + repository_selection: string; +}; +type AppsListInstallationsResponseData = Array< + AppsListInstallationsResponseDataItem +>; + type AppsGetInstallationEndpoint = { /** * installation_id parameter */ installation_id: number; -}; +} & RequiredPreview<"machine-man">; + type AppsGetInstallationRequestOptions = { method: "GET"; - url: Url; + url: "/app/installations/:installation_id"; headers: RequestHeaders; request: RequestRequestOptions; }; +type AppsGetInstallationResponseDataPermissions = { + metadata: string; + contents: string; + issues: string; + single_file: string; +}; +type AppsGetInstallationResponseDataAccount = { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; +}; +type AppsGetInstallationResponseData = { + id: number; + account: AppsGetInstallationResponseDataAccount; + access_tokens_url: string; + repositories_url: string; + html_url: string; + app_id: number; + target_id: number; + target_type: string; + permissions: AppsGetInstallationResponseDataPermissions; + events: Array; + single_file_name: string; + repository_selection: string; +}; + type AppsDeleteInstallationEndpoint = { /** * installation_id parameter */ installation_id: number; -}; +} & RequiredPreview<"machine-man">; + type AppsDeleteInstallationRequestOptions = { method: "DELETE"; - url: Url; + url: "/app/installations/:installation_id"; headers: RequestHeaders; request: RequestRequestOptions; }; + type AppsCreateInstallationTokenEndpoint = { /** * installation_id parameter @@ -2075,13 +5209,160 @@ type AppsCreateInstallationTokenEndpoint = { * The permissions granted to the access token. The permissions object includes the permission names and their access type. For a complete list of permissions and allowable values, see "[GitHub App permissions](https://developer.github.com/apps/building-github-apps/creating-github-apps-using-url-parameters/#github-app-permissions)." */ permissions?: AppsCreateInstallationTokenParamsPermissions; -}; +} & RequiredPreview<"machine-man">; + type AppsCreateInstallationTokenRequestOptions = { method: "POST"; - url: Url; + url: "/app/installations/:installation_id/access_tokens"; headers: RequestHeaders; request: RequestRequestOptions; }; +type AppsCreateInstallationTokenResponseDataRepositoriesItemPermissions = { + admin: boolean; + push: boolean; + pull: boolean; +}; +type AppsCreateInstallationTokenResponseDataRepositoriesItemOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type AppsCreateInstallationTokenResponseDataRepositoriesItem = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: AppsCreateInstallationTokenResponseDataRepositoriesItemOwner; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: null; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: Array; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: AppsCreateInstallationTokenResponseDataRepositoriesItemPermissions; + allow_rebase_merge: boolean; + template_repository: null; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; +}; +type AppsCreateInstallationTokenResponseDataPermissions = { + issues: string; + contents: string; +}; +type AppsCreateInstallationTokenResponseData = { + token: string; + expires_at: string; + permissions: AppsCreateInstallationTokenResponseDataPermissions; + repositories: Array; +}; + +type AppsSuspendInstallationEndpoint = { + /** + * installation_id parameter + */ + installation_id: number; +}; + +type AppsSuspendInstallationRequestOptions = { + method: "PUT"; + url: "/app/installations/:installation_id/suspended"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; + +type AppsUnsuspendInstallationEndpoint = { + /** + * installation_id parameter + */ + installation_id: number; +}; + +type AppsUnsuspendInstallationRequestOptions = { + method: "DELETE"; + url: "/app/installations/:installation_id/suspended"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; + type OauthAuthorizationsListGrantsEndpoint = { /** * Results per page (max 100) @@ -2092,53 +5373,90 @@ type OauthAuthorizationsListGrantsEndpoint = { */ page?: number; }; + type OauthAuthorizationsListGrantsRequestOptions = { method: "GET"; - url: Url; + url: "/applications/grants"; headers: RequestHeaders; request: RequestRequestOptions; }; +type OauthAuthorizationsListGrantsResponseDataItemApp = { + url: string; + name: string; + client_id: string; +}; +type OauthAuthorizationsListGrantsResponseDataItem = { + id: number; + url: string; + app: OauthAuthorizationsListGrantsResponseDataItemApp; + created_at: string; + updated_at: string; + scopes: Array; +}; +type OauthAuthorizationsListGrantsResponseData = Array< + OauthAuthorizationsListGrantsResponseDataItem +>; + type OauthAuthorizationsGetGrantEndpoint = { /** * grant_id parameter */ grant_id: number; }; + type OauthAuthorizationsGetGrantRequestOptions = { method: "GET"; - url: Url; + url: "/applications/grants/:grant_id"; headers: RequestHeaders; request: RequestRequestOptions; }; +type OauthAuthorizationsGetGrantResponseDataApp = { + url: string; + name: string; + client_id: string; +}; +type OauthAuthorizationsGetGrantResponseData = { + id: number; + url: string; + app: OauthAuthorizationsGetGrantResponseDataApp; + created_at: string; + updated_at: string; + scopes: Array; +}; + type OauthAuthorizationsDeleteGrantEndpoint = { /** * grant_id parameter */ grant_id: number; }; + type OauthAuthorizationsDeleteGrantRequestOptions = { method: "DELETE"; - url: Url; + url: "/applications/grants/:grant_id"; headers: RequestHeaders; request: RequestRequestOptions; }; -type OauthAuthorizationsRevokeGrantForApplicationEndpoint = { + +type AppsDeleteAuthorizationEndpoint = { /** * client_id parameter */ client_id: string; /** - * access_token parameter + * The OAuth access token used to authenticate to the GitHub API. */ - access_token: string; + access_token?: string; }; -type OauthAuthorizationsRevokeGrantForApplicationRequestOptions = { + +type AppsDeleteAuthorizationRequestOptions = { method: "DELETE"; - url: Url; + url: "/applications/:client_id/grant"; headers: RequestHeaders; request: RequestRequestOptions; }; -type OauthAuthorizationsCheckAuthorizationEndpoint = { + +type AppsRevokeGrantForApplicationEndpoint = { /** * client_id parameter */ @@ -2148,29 +5466,149 @@ type OauthAuthorizationsCheckAuthorizationEndpoint = { */ access_token: string; }; -type OauthAuthorizationsCheckAuthorizationRequestOptions = { - method: "GET"; - url: Url; + +type AppsRevokeGrantForApplicationRequestOptions = { + method: "DELETE"; + url: "/applications/:client_id/grants/:access_token"; headers: RequestHeaders; request: RequestRequestOptions; }; -type OauthAuthorizationsResetAuthorizationEndpoint = { + +type AppsCheckTokenEndpoint = { /** * client_id parameter */ client_id: string; /** - * access_token parameter + * The OAuth access token used to authenticate to the GitHub API. */ - access_token: string; + access_token?: string; }; -type OauthAuthorizationsResetAuthorizationRequestOptions = { + +type AppsCheckTokenRequestOptions = { method: "POST"; - url: Url; + url: "/applications/:client_id/token"; headers: RequestHeaders; request: RequestRequestOptions; }; -type OauthAuthorizationsRevokeAuthorizationForApplicationEndpoint = { +type AppsCheckTokenResponseDataUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type AppsCheckTokenResponseDataApp = { + url: string; + name: string; + client_id: string; +}; +type AppsCheckTokenResponseData = { + id: number; + url: string; + scopes: Array; + token: string; + token_last_eight: string; + hashed_token: string; + app: AppsCheckTokenResponseDataApp; + note: string; + note_url: string; + updated_at: string; + created_at: string; + fingerprint: string; + user: AppsCheckTokenResponseDataUser; +}; + +type AppsResetTokenEndpoint = { + /** + * client_id parameter + */ + client_id: string; + /** + * The OAuth access token used to authenticate to the GitHub API. + */ + access_token?: string; +}; + +type AppsResetTokenRequestOptions = { + method: "PATCH"; + url: "/applications/:client_id/token"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type AppsResetTokenResponseDataUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type AppsResetTokenResponseDataApp = { + url: string; + name: string; + client_id: string; +}; +type AppsResetTokenResponseData = { + id: number; + url: string; + scopes: Array; + token: string; + token_last_eight: string; + hashed_token: string; + app: AppsResetTokenResponseDataApp; + note: string; + note_url: string; + updated_at: string; + created_at: string; + fingerprint: string; + user: AppsResetTokenResponseDataUser; +}; + +type AppsDeleteTokenEndpoint = { + /** + * client_id parameter + */ + client_id: string; + /** + * The OAuth access token used to authenticate to the GitHub API. + */ + access_token?: string; +}; + +type AppsDeleteTokenRequestOptions = { + method: "DELETE"; + url: "/applications/:client_id/token"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; + +type AppsCheckAuthorizationEndpoint = { /** * client_id parameter */ @@ -2180,24 +5618,178 @@ type OauthAuthorizationsRevokeAuthorizationForApplicationEndpoint = { */ access_token: string; }; -type OauthAuthorizationsRevokeAuthorizationForApplicationRequestOptions = { - method: "DELETE"; - url: Url; + +type AppsCheckAuthorizationRequestOptions = { + method: "GET"; + url: "/applications/:client_id/tokens/:access_token"; headers: RequestHeaders; request: RequestRequestOptions; }; +type AppsCheckAuthorizationResponseDataUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type AppsCheckAuthorizationResponseDataApp = { + url: string; + name: string; + client_id: string; +}; +type AppsCheckAuthorizationResponseData = { + id: number; + url: string; + scopes: Array; + token: string; + token_last_eight: string; + hashed_token: string; + app: AppsCheckAuthorizationResponseDataApp; + note: string; + note_url: string; + updated_at: string; + created_at: string; + fingerprint: string; + user: AppsCheckAuthorizationResponseDataUser; +}; + +type AppsResetAuthorizationEndpoint = { + /** + * client_id parameter + */ + client_id: string; + /** + * access_token parameter + */ + access_token: string; +}; + +type AppsResetAuthorizationRequestOptions = { + method: "POST"; + url: "/applications/:client_id/tokens/:access_token"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type AppsResetAuthorizationResponseDataUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type AppsResetAuthorizationResponseDataApp = { + url: string; + name: string; + client_id: string; +}; +type AppsResetAuthorizationResponseData = { + id: number; + url: string; + scopes: Array; + token: string; + token_last_eight: string; + hashed_token: string; + app: AppsResetAuthorizationResponseDataApp; + note: string; + note_url: string; + updated_at: string; + created_at: string; + fingerprint: string; + user: AppsResetAuthorizationResponseDataUser; +}; + +type AppsRevokeAuthorizationForApplicationEndpoint = { + /** + * client_id parameter + */ + client_id: string; + /** + * access_token parameter + */ + access_token: string; +}; + +type AppsRevokeAuthorizationForApplicationRequestOptions = { + method: "DELETE"; + url: "/applications/:client_id/tokens/:access_token"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; + type AppsGetBySlugEndpoint = { /** * app_slug parameter */ app_slug: string; -}; +} & RequiredPreview<"machine-man">; + type AppsGetBySlugRequestOptions = { method: "GET"; - url: Url; + url: "/apps/:app_slug"; headers: RequestHeaders; request: RequestRequestOptions; }; +type AppsGetBySlugResponseDataPermissions = { + metadata: string; + contents: string; + issues: string; + single_file: string; +}; +type AppsGetBySlugResponseDataOwner = { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; +}; +type AppsGetBySlugResponseData = { + id: number; + slug: string; + node_id: string; + owner: AppsGetBySlugResponseDataOwner; + name: string; + description: string; + external_url: string; + html_url: string; + created_at: string; + updated_at: string; + permissions: AppsGetBySlugResponseDataPermissions; + events: Array; +}; + type OauthAuthorizationsListAuthorizationsEndpoint = { /** * Results per page (max 100) @@ -2208,12 +5800,36 @@ type OauthAuthorizationsListAuthorizationsEndpoint = { */ page?: number; }; + type OauthAuthorizationsListAuthorizationsRequestOptions = { method: "GET"; - url: Url; + url: "/authorizations"; headers: RequestHeaders; request: RequestRequestOptions; }; +type OauthAuthorizationsListAuthorizationsResponseDataItemApp = { + url: string; + name: string; + client_id: string; +}; +type OauthAuthorizationsListAuthorizationsResponseDataItem = { + id: number; + url: string; + scopes: Array; + token: string; + token_last_eight: string; + hashed_token: string; + app: OauthAuthorizationsListAuthorizationsResponseDataItemApp; + note: string; + note_url: string; + updated_at: string; + created_at: string; + fingerprint: string; +}; +type OauthAuthorizationsListAuthorizationsResponseData = Array< + OauthAuthorizationsListAuthorizationsResponseDataItem +>; + type OauthAuthorizationsCreateAuthorizationEndpoint = { /** * A list of scopes that this authorization is in. @@ -2240,12 +5856,33 @@ type OauthAuthorizationsCreateAuthorizationEndpoint = { */ fingerprint?: string; }; + type OauthAuthorizationsCreateAuthorizationRequestOptions = { method: "POST"; - url: Url; + url: "/authorizations"; headers: RequestHeaders; request: RequestRequestOptions; }; +type OauthAuthorizationsCreateAuthorizationResponseDataApp = { + url: string; + name: string; + client_id: string; +}; +type OauthAuthorizationsCreateAuthorizationResponseData = { + id: number; + url: string; + scopes: Array; + token: string; + token_last_eight: string; + hashed_token: string; + app: OauthAuthorizationsCreateAuthorizationResponseDataApp; + note: string; + note_url: string; + updated_at: string; + created_at: string; + fingerprint: string; +}; + type OauthAuthorizationsGetOrCreateAuthorizationForAppEndpoint = { /** * client_id parameter @@ -2272,12 +5909,33 @@ type OauthAuthorizationsGetOrCreateAuthorizationForAppEndpoint = { */ fingerprint?: string; }; + type OauthAuthorizationsGetOrCreateAuthorizationForAppRequestOptions = { method: "PUT"; - url: Url; + url: "/authorizations/clients/:client_id"; headers: RequestHeaders; request: RequestRequestOptions; }; +type OauthAuthorizationsGetOrCreateAuthorizationForAppResponseDataApp = { + url: string; + name: string; + client_id: string; +}; +type OauthAuthorizationsGetOrCreateAuthorizationForAppResponseData = { + id: number; + url: string; + scopes: Array; + token: string; + token_last_eight: string; + hashed_token: string; + app: OauthAuthorizationsGetOrCreateAuthorizationForAppResponseDataApp; + note: string; + note_url: string; + updated_at: string; + created_at: string; + fingerprint: string; +}; + type OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintEndpoint = { /** * client_id parameter @@ -2304,56 +5962,66 @@ type OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintEndpoint = { */ note_url?: string; }; + type OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintRequestOptions = { method: "PUT"; - url: Url; + url: "/authorizations/clients/:client_id/:fingerprint"; headers: RequestHeaders; request: RequestRequestOptions; }; -type OauthAuthorizationsGetOrCreateAuthorizationForAppFingerprintEndpoint = { - /** - * client_id parameter - */ +type OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintResponseDataApp = { + url: string; + name: string; client_id: string; - /** - * fingerprint parameter - */ +}; +type OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintResponseData = { + id: number; + url: string; + scopes: Array; + token: string; + token_last_eight: string; + hashed_token: string; + app: OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintResponseDataApp; + note: string; + note_url: string; + updated_at: string; + created_at: string; fingerprint: string; - /** - * The 40 character OAuth app client secret associated with the client ID specified in the URL. - */ - client_secret: string; - /** - * A list of scopes that this authorization is in. - */ - scopes?: string[]; - /** - * A note to remind you what the OAuth token is for. - */ - note?: string; - /** - * A URL to remind you what app the OAuth token is for. - */ - note_url?: string; -}; -type OauthAuthorizationsGetOrCreateAuthorizationForAppFingerprintRequestOptions = { - method: "PUT"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; }; + type OauthAuthorizationsGetAuthorizationEndpoint = { /** * authorization_id parameter */ authorization_id: number; }; + type OauthAuthorizationsGetAuthorizationRequestOptions = { method: "GET"; - url: Url; + url: "/authorizations/:authorization_id"; headers: RequestHeaders; request: RequestRequestOptions; }; +type OauthAuthorizationsGetAuthorizationResponseDataApp = { + url: string; + name: string; + client_id: string; +}; +type OauthAuthorizationsGetAuthorizationResponseData = { + id: number; + url: string; + scopes: Array; + token: string; + token_last_eight: string; + hashed_token: string; + app: OauthAuthorizationsGetAuthorizationResponseDataApp; + note: string; + note_url: string; + updated_at: string; + created_at: string; + fingerprint: string; +}; + type OauthAuthorizationsUpdateAuthorizationEndpoint = { /** * authorization_id parameter @@ -2384,43 +6052,86 @@ type OauthAuthorizationsUpdateAuthorizationEndpoint = { */ fingerprint?: string; }; + type OauthAuthorizationsUpdateAuthorizationRequestOptions = { method: "PATCH"; - url: Url; + url: "/authorizations/:authorization_id"; headers: RequestHeaders; request: RequestRequestOptions; }; +type OauthAuthorizationsUpdateAuthorizationResponseDataApp = { + url: string; + name: string; + client_id: string; +}; +type OauthAuthorizationsUpdateAuthorizationResponseData = { + id: number; + url: string; + scopes: Array; + token: string; + token_last_eight: string; + hashed_token: string; + app: OauthAuthorizationsUpdateAuthorizationResponseDataApp; + note: string; + note_url: string; + updated_at: string; + created_at: string; + fingerprint: string; +}; + type OauthAuthorizationsDeleteAuthorizationEndpoint = { /** * authorization_id parameter */ authorization_id: number; }; + type OauthAuthorizationsDeleteAuthorizationRequestOptions = { method: "DELETE"; - url: Url; + url: "/authorizations/:authorization_id"; headers: RequestHeaders; request: RequestRequestOptions; }; -type CodesOfConductListConductCodesEndpoint = {}; -type CodesOfConductListConductCodesRequestOptions = { + +type CodesOfConductGetAllCodesOfConductEndpoint = {} & RequiredPreview< + "scarlet-witch" +>; + +type CodesOfConductGetAllCodesOfConductRequestOptions = { method: "GET"; - url: Url; + url: "/codes_of_conduct"; headers: RequestHeaders; request: RequestRequestOptions; }; +type CodesOfConductGetAllCodesOfConductResponseDataItem = { + key: string; + name: string; + url: string; +}; +type CodesOfConductGetAllCodesOfConductResponseData = Array< + CodesOfConductGetAllCodesOfConductResponseDataItem +>; + type CodesOfConductGetConductCodeEndpoint = { /** * key parameter */ key: string; -}; +} & RequiredPreview<"scarlet-witch">; + type CodesOfConductGetConductCodeRequestOptions = { method: "GET"; - url: Url; + url: "/codes_of_conduct/:key"; headers: RequestHeaders; request: RequestRequestOptions; }; +type CodesOfConductGetConductCodeResponseData = { + key: string; + name: string; + url: string; + body: string; +}; + type AppsCreateContentAttachmentEndpoint = { /** * content_reference_id parameter @@ -2434,20 +6145,29 @@ type AppsCreateContentAttachmentEndpoint = { * The body text of the content attachment displayed in the body or comment of an issue or pull request. This parameter supports markdown. */ body: string; -}; +} & RequiredPreview<"corsair">; + type AppsCreateContentAttachmentRequestOptions = { method: "POST"; - url: Url; + url: "/content_references/:content_reference_id/attachments"; headers: RequestHeaders; request: RequestRequestOptions; }; +type AppsCreateContentAttachmentResponseData = { + id: number; + title: string; + body: string; +}; + type EmojisGetEndpoint = {}; + type EmojisGetRequestOptions = { method: "GET"; - url: Url; + url: "/emojis"; headers: RequestHeaders; request: RequestRequestOptions; }; + type ActivityListPublicEventsEndpoint = { /** * Results per page (max 100) @@ -2458,19 +6178,72 @@ type ActivityListPublicEventsEndpoint = { */ page?: number; }; + type ActivityListPublicEventsRequestOptions = { method: "GET"; - url: Url; + url: "/events"; headers: RequestHeaders; request: RequestRequestOptions; }; -type ActivityListFeedsEndpoint = {}; -type ActivityListFeedsRequestOptions = { + +type ActivityGetFeedsEndpoint = {}; + +type ActivityGetFeedsRequestOptions = { method: "GET"; - url: Url; + url: "/feeds"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ActivityGetFeedsResponseDataLinksSecurityAdvisories = { + href: string; + type: string; +}; +type ActivityGetFeedsResponseDataLinksCurrentUserOrganizationsItem = { + href: string; + type: string; +}; +type ActivityGetFeedsResponseDataLinksCurrentUserOrganization = { + href: string; + type: string; +}; +type ActivityGetFeedsResponseDataLinksCurrentUserActor = { + href: string; + type: string; +}; +type ActivityGetFeedsResponseDataLinksCurrentUser = { + href: string; + type: string; +}; +type ActivityGetFeedsResponseDataLinksCurrentUserPublic = { + href: string; + type: string; +}; +type ActivityGetFeedsResponseDataLinksUser = { href: string; type: string }; +type ActivityGetFeedsResponseDataLinksTimeline = { href: string; type: string }; +type ActivityGetFeedsResponseDataLinks = { + timeline: ActivityGetFeedsResponseDataLinksTimeline; + user: ActivityGetFeedsResponseDataLinksUser; + current_user_public: ActivityGetFeedsResponseDataLinksCurrentUserPublic; + current_user: ActivityGetFeedsResponseDataLinksCurrentUser; + current_user_actor: ActivityGetFeedsResponseDataLinksCurrentUserActor; + current_user_organization: ActivityGetFeedsResponseDataLinksCurrentUserOrganization; + current_user_organizations: Array< + ActivityGetFeedsResponseDataLinksCurrentUserOrganizationsItem + >; + security_advisories: ActivityGetFeedsResponseDataLinksSecurityAdvisories; +}; +type ActivityGetFeedsResponseData = { + timeline_url: string; + user_url: string; + current_user_public_url: string; + current_user_url: string; + current_user_actor_url: string; + current_user_organization_url: string; + current_user_organization_urls: Array; + security_advisories_url: string; + _links: ActivityGetFeedsResponseDataLinks; +}; + type GistsListEndpoint = { /** * This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only gists updated at or after this time are returned. @@ -2485,12 +6258,65 @@ type GistsListEndpoint = { */ page?: number; }; + type GistsListRequestOptions = { method: "GET"; - url: Url; + url: "/gists"; headers: RequestHeaders; request: RequestRequestOptions; }; +type GistsListResponseDataItemOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type GistsListResponseDataItemFilesHelloWorldRb = { + filename: string; + type: string; + language: string; + raw_url: string; + size: number; +}; +type GistsListResponseDataItemFiles = { + "hello_world.rb": GistsListResponseDataItemFilesHelloWorldRb; +}; +type GistsListResponseDataItem = { + url: string; + forks_url: string; + commits_url: string; + id: string; + node_id: string; + git_pull_url: string; + git_push_url: string; + html_url: string; + files: GistsListResponseDataItemFiles; + public: boolean; + created_at: string; + updated_at: string; + description: string; + comments: number; + user: null; + comments_url: string; + owner: GistsListResponseDataItemOwner; + truncated: boolean; +}; +type GistsListResponseData = Array; + type GistsCreateEndpoint = { /** * The filenames and content of each file in the gist. The keys in the `files` object represent the filename and have the type `string`. @@ -2505,12 +6331,157 @@ type GistsCreateEndpoint = { */ public?: boolean; }; + type GistsCreateRequestOptions = { method: "POST"; - url: Url; + url: "/gists"; headers: RequestHeaders; request: RequestRequestOptions; }; +type GistsCreateResponseDataHistoryItemChangeStatus = { + deletions: number; + additions: number; + total: number; +}; +type GistsCreateResponseDataHistoryItemUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type GistsCreateResponseDataHistoryItem = { + url: string; + version: string; + user: GistsCreateResponseDataHistoryItemUser; + change_status: GistsCreateResponseDataHistoryItemChangeStatus; + committed_at: string; +}; +type GistsCreateResponseDataForksItemUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type GistsCreateResponseDataForksItem = { + user: GistsCreateResponseDataForksItemUser; + url: string; + id: string; + created_at: string; + updated_at: string; +}; +type GistsCreateResponseDataOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type GistsCreateResponseDataFilesHelloWorldPythonTxt = { + filename: string; + type: string; + language: string; + raw_url: string; + size: number; + truncated: boolean; + content: string; +}; +type GistsCreateResponseDataFilesHelloWorldRubyTxt = { + filename: string; + type: string; + language: string; + raw_url: string; + size: number; + truncated: boolean; + content: string; +}; +type GistsCreateResponseDataFilesHelloWorldPy = { + filename: string; + type: string; + language: string; + raw_url: string; + size: number; + truncated: boolean; + content: string; +}; +type GistsCreateResponseDataFilesHelloWorldRb = { + filename: string; + type: string; + language: string; + raw_url: string; + size: number; + truncated: boolean; + content: string; +}; +type GistsCreateResponseDataFiles = { + "hello_world.rb": GistsCreateResponseDataFilesHelloWorldRb; + "hello_world.py": GistsCreateResponseDataFilesHelloWorldPy; + "hello_world_ruby.txt": GistsCreateResponseDataFilesHelloWorldRubyTxt; + "hello_world_python.txt": GistsCreateResponseDataFilesHelloWorldPythonTxt; +}; +type GistsCreateResponseData = { + url: string; + forks_url: string; + commits_url: string; + id: string; + node_id: string; + git_pull_url: string; + git_push_url: string; + html_url: string; + files: GistsCreateResponseDataFiles; + public: boolean; + created_at: string; + updated_at: string; + description: string; + comments: number; + user: null; + comments_url: string; + owner: GistsCreateResponseDataOwner; + truncated: boolean; + forks: Array; + history: Array; +}; + type GistsListPublicEndpoint = { /** * This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only gists updated at or after this time are returned. @@ -2525,12 +6496,65 @@ type GistsListPublicEndpoint = { */ page?: number; }; + type GistsListPublicRequestOptions = { method: "GET"; - url: Url; + url: "/gists/public"; headers: RequestHeaders; request: RequestRequestOptions; }; +type GistsListPublicResponseDataItemOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type GistsListPublicResponseDataItemFilesHelloWorldRb = { + filename: string; + type: string; + language: string; + raw_url: string; + size: number; +}; +type GistsListPublicResponseDataItemFiles = { + "hello_world.rb": GistsListPublicResponseDataItemFilesHelloWorldRb; +}; +type GistsListPublicResponseDataItem = { + url: string; + forks_url: string; + commits_url: string; + id: string; + node_id: string; + git_pull_url: string; + git_push_url: string; + html_url: string; + files: GistsListPublicResponseDataItemFiles; + public: boolean; + created_at: string; + updated_at: string; + description: string; + comments: number; + user: null; + comments_url: string; + owner: GistsListPublicResponseDataItemOwner; + truncated: boolean; +}; +type GistsListPublicResponseData = Array; + type GistsListStarredEndpoint = { /** * This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only gists updated at or after this time are returned. @@ -2545,24 +6569,222 @@ type GistsListStarredEndpoint = { */ page?: number; }; + type GistsListStarredRequestOptions = { method: "GET"; - url: Url; + url: "/gists/starred"; headers: RequestHeaders; request: RequestRequestOptions; }; +type GistsListStarredResponseDataItemOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type GistsListStarredResponseDataItemFilesHelloWorldRb = { + filename: string; + type: string; + language: string; + raw_url: string; + size: number; +}; +type GistsListStarredResponseDataItemFiles = { + "hello_world.rb": GistsListStarredResponseDataItemFilesHelloWorldRb; +}; +type GistsListStarredResponseDataItem = { + url: string; + forks_url: string; + commits_url: string; + id: string; + node_id: string; + git_pull_url: string; + git_push_url: string; + html_url: string; + files: GistsListStarredResponseDataItemFiles; + public: boolean; + created_at: string; + updated_at: string; + description: string; + comments: number; + user: null; + comments_url: string; + owner: GistsListStarredResponseDataItemOwner; + truncated: boolean; +}; +type GistsListStarredResponseData = Array; + type GistsGetEndpoint = { /** * gist_id parameter */ gist_id: string; }; + type GistsGetRequestOptions = { method: "GET"; - url: Url; + url: "/gists/:gist_id"; headers: RequestHeaders; request: RequestRequestOptions; }; +type GistsGetResponseDataHistoryItemChangeStatus = { + deletions: number; + additions: number; + total: number; +}; +type GistsGetResponseDataHistoryItemUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type GistsGetResponseDataHistoryItem = { + url: string; + version: string; + user: GistsGetResponseDataHistoryItemUser; + change_status: GistsGetResponseDataHistoryItemChangeStatus; + committed_at: string; +}; +type GistsGetResponseDataForksItemUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type GistsGetResponseDataForksItem = { + user: GistsGetResponseDataForksItemUser; + url: string; + id: string; + created_at: string; + updated_at: string; +}; +type GistsGetResponseDataOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type GistsGetResponseDataFilesHelloWorldPythonTxt = { + filename: string; + type: string; + language: string; + raw_url: string; + size: number; + truncated: boolean; + content: string; +}; +type GistsGetResponseDataFilesHelloWorldRubyTxt = { + filename: string; + type: string; + language: string; + raw_url: string; + size: number; + truncated: boolean; + content: string; +}; +type GistsGetResponseDataFilesHelloWorldPy = { + filename: string; + type: string; + language: string; + raw_url: string; + size: number; + truncated: boolean; + content: string; +}; +type GistsGetResponseDataFilesHelloWorldRb = { + filename: string; + type: string; + language: string; + raw_url: string; + size: number; + truncated: boolean; + content: string; +}; +type GistsGetResponseDataFiles = { + "hello_world.rb": GistsGetResponseDataFilesHelloWorldRb; + "hello_world.py": GistsGetResponseDataFilesHelloWorldPy; + "hello_world_ruby.txt": GistsGetResponseDataFilesHelloWorldRubyTxt; + "hello_world_python.txt": GistsGetResponseDataFilesHelloWorldPythonTxt; +}; +type GistsGetResponseData = { + url: string; + forks_url: string; + commits_url: string; + id: string; + node_id: string; + git_pull_url: string; + git_push_url: string; + html_url: string; + files: GistsGetResponseDataFiles; + public: boolean; + created_at: string; + updated_at: string; + description: string; + comments: number; + user: null; + comments_url: string; + owner: GistsGetResponseDataOwner; + truncated: boolean; + forks: Array; + history: Array; +}; + type GistsUpdateEndpoint = { /** * gist_id parameter @@ -2577,24 +6799,171 @@ type GistsUpdateEndpoint = { */ files?: GistsUpdateParamsFiles; }; + type GistsUpdateRequestOptions = { method: "PATCH"; - url: Url; + url: "/gists/:gist_id"; headers: RequestHeaders; request: RequestRequestOptions; }; +type GistsUpdateResponseDataHistoryItemChangeStatus = { + deletions: number; + additions: number; + total: number; +}; +type GistsUpdateResponseDataHistoryItemUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type GistsUpdateResponseDataHistoryItem = { + url: string; + version: string; + user: GistsUpdateResponseDataHistoryItemUser; + change_status: GistsUpdateResponseDataHistoryItemChangeStatus; + committed_at: string; +}; +type GistsUpdateResponseDataForksItemUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type GistsUpdateResponseDataForksItem = { + user: GistsUpdateResponseDataForksItemUser; + url: string; + id: string; + created_at: string; + updated_at: string; +}; +type GistsUpdateResponseDataOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type GistsUpdateResponseDataFilesNewFileTxt = { + filename: string; + type: string; + language: string; + raw_url: string; + size: number; + truncated: boolean; + content: string; +}; +type GistsUpdateResponseDataFilesHelloWorldMd = { + filename: string; + type: string; + language: string; + raw_url: string; + size: number; + truncated: boolean; + content: string; +}; +type GistsUpdateResponseDataFilesHelloWorldPy = { + filename: string; + type: string; + language: string; + raw_url: string; + size: number; + truncated: boolean; + content: string; +}; +type GistsUpdateResponseDataFilesHelloWorldRb = { + filename: string; + type: string; + language: string; + raw_url: string; + size: number; + truncated: boolean; + content: string; +}; +type GistsUpdateResponseDataFiles = { + "hello_world.rb": GistsUpdateResponseDataFilesHelloWorldRb; + "hello_world.py": GistsUpdateResponseDataFilesHelloWorldPy; + "hello_world.md": GistsUpdateResponseDataFilesHelloWorldMd; + "new_file.txt": GistsUpdateResponseDataFilesNewFileTxt; +}; +type GistsUpdateResponseData = { + url: string; + forks_url: string; + commits_url: string; + id: string; + node_id: string; + git_pull_url: string; + git_push_url: string; + html_url: string; + files: GistsUpdateResponseDataFiles; + public: boolean; + created_at: string; + updated_at: string; + description: string; + comments: number; + user: null; + comments_url: string; + owner: GistsUpdateResponseDataOwner; + truncated: boolean; + forks: Array; + history: Array; +}; + type GistsDeleteEndpoint = { /** * gist_id parameter */ gist_id: string; }; + type GistsDeleteRequestOptions = { method: "DELETE"; - url: Url; + url: "/gists/:gist_id"; headers: RequestHeaders; request: RequestRequestOptions; }; + type GistsListCommentsEndpoint = { /** * gist_id parameter @@ -2609,12 +6978,44 @@ type GistsListCommentsEndpoint = { */ page?: number; }; + type GistsListCommentsRequestOptions = { method: "GET"; - url: Url; + url: "/gists/:gist_id/comments"; headers: RequestHeaders; request: RequestRequestOptions; }; +type GistsListCommentsResponseDataItemUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type GistsListCommentsResponseDataItem = { + id: number; + node_id: string; + url: string; + body: string; + user: GistsListCommentsResponseDataItemUser; + created_at: string; + updated_at: string; +}; +type GistsListCommentsResponseData = Array; + type GistsCreateCommentEndpoint = { /** * gist_id parameter @@ -2625,12 +7026,43 @@ type GistsCreateCommentEndpoint = { */ body: string; }; + type GistsCreateCommentRequestOptions = { method: "POST"; - url: Url; + url: "/gists/:gist_id/comments"; headers: RequestHeaders; request: RequestRequestOptions; }; +type GistsCreateCommentResponseDataUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type GistsCreateCommentResponseData = { + id: number; + node_id: string; + url: string; + body: string; + user: GistsCreateCommentResponseDataUser; + created_at: string; + updated_at: string; +}; + type GistsGetCommentEndpoint = { /** * gist_id parameter @@ -2641,12 +7073,43 @@ type GistsGetCommentEndpoint = { */ comment_id: number; }; + type GistsGetCommentRequestOptions = { method: "GET"; - url: Url; + url: "/gists/:gist_id/comments/:comment_id"; headers: RequestHeaders; request: RequestRequestOptions; }; +type GistsGetCommentResponseDataUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type GistsGetCommentResponseData = { + id: number; + node_id: string; + url: string; + body: string; + user: GistsGetCommentResponseDataUser; + created_at: string; + updated_at: string; +}; + type GistsUpdateCommentEndpoint = { /** * gist_id parameter @@ -2661,12 +7124,43 @@ type GistsUpdateCommentEndpoint = { */ body: string; }; + type GistsUpdateCommentRequestOptions = { method: "PATCH"; - url: Url; + url: "/gists/:gist_id/comments/:comment_id"; headers: RequestHeaders; request: RequestRequestOptions; }; +type GistsUpdateCommentResponseDataUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type GistsUpdateCommentResponseData = { + id: number; + node_id: string; + url: string; + body: string; + user: GistsUpdateCommentResponseDataUser; + created_at: string; + updated_at: string; +}; + type GistsDeleteCommentEndpoint = { /** * gist_id parameter @@ -2677,12 +7171,14 @@ type GistsDeleteCommentEndpoint = { */ comment_id: number; }; + type GistsDeleteCommentRequestOptions = { method: "DELETE"; - url: Url; + url: "/gists/:gist_id/comments/:comment_id"; headers: RequestHeaders; request: RequestRequestOptions; }; + type GistsListCommitsEndpoint = { /** * gist_id parameter @@ -2697,24 +7193,111 @@ type GistsListCommitsEndpoint = { */ page?: number; }; + type GistsListCommitsRequestOptions = { method: "GET"; - url: Url; + url: "/gists/:gist_id/commits"; headers: RequestHeaders; request: RequestRequestOptions; }; +type GistsListCommitsResponseDataItemChangeStatus = { + deletions: number; + additions: number; + total: number; +}; +type GistsListCommitsResponseDataItemUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type GistsListCommitsResponseDataItem = { + url: string; + version: string; + user: GistsListCommitsResponseDataItemUser; + change_status: GistsListCommitsResponseDataItemChangeStatus; + committed_at: string; +}; +type GistsListCommitsResponseData = Array; + type GistsForkEndpoint = { /** * gist_id parameter */ gist_id: string; }; + type GistsForkRequestOptions = { method: "POST"; - url: Url; + url: "/gists/:gist_id/forks"; headers: RequestHeaders; request: RequestRequestOptions; }; +type GistsForkResponseDataOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type GistsForkResponseDataFilesHelloWorldRb = { + filename: string; + type: string; + language: string; + raw_url: string; + size: number; +}; +type GistsForkResponseDataFiles = { + "hello_world.rb": GistsForkResponseDataFilesHelloWorldRb; +}; +type GistsForkResponseData = { + url: string; + forks_url: string; + commits_url: string; + id: string; + node_id: string; + git_pull_url: string; + git_push_url: string; + html_url: string; + files: GistsForkResponseDataFiles; + public: boolean; + created_at: string; + updated_at: string; + description: string; + comments: number; + user: null; + comments_url: string; + owner: GistsForkResponseDataOwner; + truncated: boolean; +}; + type GistsListForksEndpoint = { /** * gist_id parameter @@ -2729,48 +7312,84 @@ type GistsListForksEndpoint = { */ page?: number; }; + type GistsListForksRequestOptions = { method: "GET"; - url: Url; + url: "/gists/:gist_id/forks"; headers: RequestHeaders; request: RequestRequestOptions; }; +type GistsListForksResponseDataItemUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type GistsListForksResponseDataItem = { + user: GistsListForksResponseDataItemUser; + url: string; + id: string; + created_at: string; + updated_at: string; +}; +type GistsListForksResponseData = Array; + type GistsStarEndpoint = { /** * gist_id parameter */ gist_id: string; }; + type GistsStarRequestOptions = { method: "PUT"; - url: Url; + url: "/gists/:gist_id/star"; headers: RequestHeaders; request: RequestRequestOptions; }; + type GistsUnstarEndpoint = { /** * gist_id parameter */ gist_id: string; }; + type GistsUnstarRequestOptions = { method: "DELETE"; - url: Url; + url: "/gists/:gist_id/star"; headers: RequestHeaders; request: RequestRequestOptions; }; + type GistsCheckIsStarredEndpoint = { /** * gist_id parameter */ gist_id: string; }; + type GistsCheckIsStarredRequestOptions = { method: "GET"; - url: Url; + url: "/gists/:gist_id/star"; headers: RequestHeaders; request: RequestRequestOptions; }; + type GistsGetRevisionEndpoint = { /** * gist_id parameter @@ -2781,31 +7400,182 @@ type GistsGetRevisionEndpoint = { */ sha: string; }; + type GistsGetRevisionRequestOptions = { method: "GET"; - url: Url; + url: "/gists/:gist_id/:sha"; headers: RequestHeaders; request: RequestRequestOptions; }; +type GistsGetRevisionResponseDataHistoryItemChangeStatus = { + deletions: number; + additions: number; + total: number; +}; +type GistsGetRevisionResponseDataHistoryItemUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type GistsGetRevisionResponseDataHistoryItem = { + url: string; + version: string; + user: GistsGetRevisionResponseDataHistoryItemUser; + change_status: GistsGetRevisionResponseDataHistoryItemChangeStatus; + committed_at: string; +}; +type GistsGetRevisionResponseDataForksItemUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type GistsGetRevisionResponseDataForksItem = { + user: GistsGetRevisionResponseDataForksItemUser; + url: string; + id: string; + created_at: string; + updated_at: string; +}; +type GistsGetRevisionResponseDataOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type GistsGetRevisionResponseDataFilesHelloWorldPythonTxt = { + filename: string; + type: string; + language: string; + raw_url: string; + size: number; + truncated: boolean; + content: string; +}; +type GistsGetRevisionResponseDataFilesHelloWorldRubyTxt = { + filename: string; + type: string; + language: string; + raw_url: string; + size: number; + truncated: boolean; + content: string; +}; +type GistsGetRevisionResponseDataFilesHelloWorldPy = { + filename: string; + type: string; + language: string; + raw_url: string; + size: number; + truncated: boolean; + content: string; +}; +type GistsGetRevisionResponseDataFilesHelloWorldRb = { + filename: string; + type: string; + language: string; + raw_url: string; + size: number; + truncated: boolean; + content: string; +}; +type GistsGetRevisionResponseDataFiles = { + "hello_world.rb": GistsGetRevisionResponseDataFilesHelloWorldRb; + "hello_world.py": GistsGetRevisionResponseDataFilesHelloWorldPy; + "hello_world_ruby.txt": GistsGetRevisionResponseDataFilesHelloWorldRubyTxt; + "hello_world_python.txt": GistsGetRevisionResponseDataFilesHelloWorldPythonTxt; +}; +type GistsGetRevisionResponseData = { + url: string; + forks_url: string; + commits_url: string; + id: string; + node_id: string; + git_pull_url: string; + git_push_url: string; + html_url: string; + files: GistsGetRevisionResponseDataFiles; + public: boolean; + created_at: string; + updated_at: string; + description: string; + comments: number; + user: null; + comments_url: string; + owner: GistsGetRevisionResponseDataOwner; + truncated: boolean; + forks: Array; + history: Array; +}; + type GitignoreListTemplatesEndpoint = {}; + type GitignoreListTemplatesRequestOptions = { method: "GET"; - url: Url; + url: "/gitignore/templates"; headers: RequestHeaders; request: RequestRequestOptions; }; +type GitignoreListTemplatesResponseData = Array; + type GitignoreGetTemplateEndpoint = { /** * name parameter */ name: string; }; + type GitignoreGetTemplateRequestOptions = { method: "GET"; - url: Url; + url: "/gitignore/templates/:name"; headers: RequestHeaders; request: RequestRequestOptions; }; +type GitignoreGetTemplateResponseData = { name: string; source: string }; + type AppsListReposEndpoint = { /** * Results per page (max 100) @@ -2815,13 +7585,129 @@ type AppsListReposEndpoint = { * Page number of the results to fetch. */ page?: number; -}; +} & RequiredPreview<"machine-man">; + type AppsListReposRequestOptions = { method: "GET"; - url: Url; + url: "/installation/repositories"; headers: RequestHeaders; request: RequestRequestOptions; }; +type AppsListReposResponseDataRepositoriesItemOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type AppsListReposResponseDataRepositoriesItem = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: AppsListReposResponseDataRepositoriesItemOwner; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: null; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: Array; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + allow_rebase_merge: boolean; + template_repository: null; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; +}; +type AppsListReposResponseData = { + total_count: number; + repositories: Array; +}; + +type AppsRevokeInstallationTokenEndpoint = {}; + +type AppsRevokeInstallationTokenRequestOptions = { + method: "DELETE"; + url: "/installation/token"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; + type IssuesListEndpoint = { /** * Indicates which sorts of issues to return. Can be one of: @@ -2861,12 +7747,262 @@ type IssuesListEndpoint = { */ page?: number; }; + type IssuesListRequestOptions = { method: "GET"; - url: Url; + url: "/issues"; headers: RequestHeaders; request: RequestRequestOptions; }; +type IssuesListResponseDataItemRepositoryPermissions = { + admin: boolean; + push: boolean; + pull: boolean; +}; +type IssuesListResponseDataItemRepositoryOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type IssuesListResponseDataItemRepository = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: IssuesListResponseDataItemRepositoryOwner; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: null; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: Array; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: IssuesListResponseDataItemRepositoryPermissions; + allow_rebase_merge: boolean; + template_repository: null; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; +}; +type IssuesListResponseDataItemPullRequest = { + url: string; + html_url: string; + diff_url: string; + patch_url: string; +}; +type IssuesListResponseDataItemMilestoneCreator = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type IssuesListResponseDataItemMilestone = { + url: string; + html_url: string; + labels_url: string; + id: number; + node_id: string; + number: number; + state: string; + title: string; + description: string; + creator: IssuesListResponseDataItemMilestoneCreator; + open_issues: number; + closed_issues: number; + created_at: string; + updated_at: string; + closed_at: string; + due_on: string; +}; +type IssuesListResponseDataItemAssigneesItem = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type IssuesListResponseDataItemAssignee = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type IssuesListResponseDataItemLabelsItem = { + id: number; + node_id: string; + url: string; + name: string; + description: string; + color: string; + default: boolean; +}; +type IssuesListResponseDataItemUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type IssuesListResponseDataItem = { + id: number; + node_id: string; + url: string; + repository_url: string; + labels_url: string; + comments_url: string; + events_url: string; + html_url: string; + number: number; + state: string; + title: string; + body: string; + user: IssuesListResponseDataItemUser; + labels: Array; + assignee: IssuesListResponseDataItemAssignee; + assignees: Array; + milestone: IssuesListResponseDataItemMilestone; + locked: boolean; + active_lock_reason: string; + comments: number; + pull_request: IssuesListResponseDataItemPullRequest; + closed_at: null; + created_at: string; + updated_at: string; + repository: IssuesListResponseDataItemRepository; +}; +type IssuesListResponseData = Array; + type SearchIssuesLegacyEndpoint = { /** * owner parameter @@ -2885,12 +8021,32 @@ type SearchIssuesLegacyEndpoint = { */ keyword: string; }; + type SearchIssuesLegacyRequestOptions = { method: "GET"; - url: Url; + url: "/legacy/issues/search/:owner/:repository/:state/:keyword"; headers: RequestHeaders; request: RequestRequestOptions; }; +type SearchIssuesLegacyResponseDataIssuesItem = { + gravatar_id: string; + position: number; + number: number; + votes: number; + created_at: string; + comments: number; + body: string; + title: string; + updated_at: string; + html_url: string; + user: string; + labels: Array; + state: string; +}; +type SearchIssuesLegacyResponseData = { + issues: Array; +}; + type SearchReposLegacyEndpoint = { /** * The search term. @@ -2913,24 +8069,76 @@ type SearchReposLegacyEndpoint = { */ order?: "asc" | "desc"; }; + type SearchReposLegacyRequestOptions = { method: "GET"; - url: Url; + url: "/legacy/repos/search/:keyword"; headers: RequestHeaders; request: RequestRequestOptions; }; +type SearchReposLegacyResponseDataRepositoriesItem = { + type: string; + created: string; + watchers: number; + has_downloads: boolean; + username: string; + homepage: string; + url: string; + fork: boolean; + has_issues: boolean; + has_wiki: boolean; + forks: number; + size: number; + private: boolean; + followers: number; + name: string; + owner: string; + open_issues: number; + pushed_at: string; + score: number; + pushed: string; + description: string; + language: string; + created_at: string; +}; +type SearchReposLegacyResponseData = { + repositories: Array; +}; + type SearchEmailLegacyEndpoint = { /** * The email address. */ email: string; }; + type SearchEmailLegacyRequestOptions = { method: "GET"; - url: Url; + url: "/legacy/user/email/:email"; headers: RequestHeaders; request: RequestRequestOptions; }; +type SearchEmailLegacyResponseDataUser = { + public_repo_count: number; + public_gist_count: number; + followers_count: number; + following_count: number; + created: string; + created_at: string; + name: string; + company: string; + blog: string; + location: string; + email: string; + id: number; + login: string; + type: string; + gravatar_id: string; +}; +type SearchEmailLegacyResponseData = { + user: SearchEmailLegacyResponseDataUser; +}; + type SearchUsersLegacyEndpoint = { /** * The search term. @@ -2949,38 +8157,83 @@ type SearchUsersLegacyEndpoint = { */ order?: "asc" | "desc"; }; + type SearchUsersLegacyRequestOptions = { method: "GET"; - url: Url; + url: "/legacy/user/search/:keyword"; headers: RequestHeaders; request: RequestRequestOptions; }; +type SearchUsersLegacyResponseDataUsersItem = { + gravatar_id: string; + name: string; + created_at: string; + location: string; + public_repo_count: number; + followers: number; + language: string; + fullname: string; + username: string; + id: string; + repos: number; + type: string; + followers_count: number; + login: string; + score: number; + created: string; +}; +type SearchUsersLegacyResponseData = { + users: Array; +}; + type LicensesListCommonlyUsedEndpoint = {}; + type LicensesListCommonlyUsedRequestOptions = { method: "GET"; - url: Url; + url: "/licenses"; headers: RequestHeaders; request: RequestRequestOptions; }; -type LicensesListEndpoint = {}; -type LicensesListRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; +type LicensesListCommonlyUsedResponseDataItem = { + key: string; + name: string; + spdx_id: string; + url: string; + node_id?: string; }; +type LicensesListCommonlyUsedResponseData = Array< + LicensesListCommonlyUsedResponseDataItem +>; + type LicensesGetEndpoint = { /** * license parameter */ license: string; }; + type LicensesGetRequestOptions = { method: "GET"; - url: Url; + url: "/licenses/:license"; headers: RequestHeaders; request: RequestRequestOptions; }; +type LicensesGetResponseData = { + key: string; + name: string; + spdx_id: string; + url: string; + node_id: string; + html_url: string; + description: string; + implementation: string; + permissions: Array; + conditions: Array; + limitations: Array; + body: string; + featured: boolean; +}; + type MarkdownRenderEndpoint = { /** * The Markdown text to render in HTML. Markdown content must be 400 KB or less. @@ -2997,44 +8250,96 @@ type MarkdownRenderEndpoint = { */ context?: string; }; + type MarkdownRenderRequestOptions = { method: "POST"; - url: Url; + url: "/markdown"; headers: RequestHeaders; request: RequestRequestOptions; }; + type MarkdownRenderRawEndpoint = { /** * data parameter */ data: string; -}; +} & { headers: { "content-type": "text/plain; charset=utf-8" } }; type MarkdownRenderRawRequestOptions = { method: "POST"; - url: Url; + url: "/markdown/raw"; headers: RequestHeaders; request: RequestRequestOptions; }; -type AppsCheckAccountIsAssociatedWithAnyEndpoint = { + +type AppsGetSubscriptionPlanForAccountEndpoint = { /** * account_id parameter */ account_id: number; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; }; -type AppsCheckAccountIsAssociatedWithAnyRequestOptions = { + +type AppsGetSubscriptionPlanForAccountRequestOptions = { method: "GET"; - url: Url; + url: "/marketplace_listing/accounts/:account_id"; headers: RequestHeaders; request: RequestRequestOptions; }; +type AppsGetSubscriptionPlanForAccountResponseDataMarketplacePurchasePlan = { + url: string; + accounts_url: string; + id: number; + number: number; + name: string; + description: string; + monthly_price_in_cents: number; + yearly_price_in_cents: number; + price_model: string; + has_free_trial: boolean; + unit_name: null; + state: string; + bullets: Array; +}; +type AppsGetSubscriptionPlanForAccountResponseDataMarketplacePurchase = { + billing_cycle: string; + next_billing_date: string; + unit_count: null; + on_free_trial: boolean; + free_trial_ends_on: string; + updated_at: string; + plan: AppsGetSubscriptionPlanForAccountResponseDataMarketplacePurchasePlan; +}; +type AppsGetSubscriptionPlanForAccountResponseDataMarketplacePendingChangePlan = { + url: string; + accounts_url: string; + id: number; + number: number; + name: string; + description: string; + monthly_price_in_cents: number; + yearly_price_in_cents: number; + price_model: string; + has_free_trial: boolean; + state: string; + unit_name: null; + bullets: Array; +}; +type AppsGetSubscriptionPlanForAccountResponseDataMarketplacePendingChange = { + effective_date: string; + unit_count: null; + id: number; + plan: AppsGetSubscriptionPlanForAccountResponseDataMarketplacePendingChangePlan; +}; +type AppsGetSubscriptionPlanForAccountResponseData = { + url: string; + type: string; + id: number; + login: string; + email: null; + organization_billing_email: string; + marketplace_pending_change: AppsGetSubscriptionPlanForAccountResponseDataMarketplacePendingChange; + marketplace_purchase: AppsGetSubscriptionPlanForAccountResponseDataMarketplacePurchase; +}; + type AppsListPlansEndpoint = { /** * Results per page (max 100) @@ -3045,13 +8350,31 @@ type AppsListPlansEndpoint = { */ page?: number; }; + type AppsListPlansRequestOptions = { method: "GET"; - url: Url; + url: "/marketplace_listing/plans"; headers: RequestHeaders; request: RequestRequestOptions; }; -type AppsListAccountsUserOrOrgOnPlanEndpoint = { +type AppsListPlansResponseDataItem = { + url: string; + accounts_url: string; + id: number; + number: number; + name: string; + description: string; + monthly_price_in_cents: number; + yearly_price_in_cents: number; + price_model: string; + has_free_trial: boolean; + unit_name: null; + state: string; + bullets: Array; +}; +type AppsListPlansResponseData = Array; + +type AppsListAccountsForPlanEndpoint = { /** * plan_id parameter */ @@ -3073,32 +8396,141 @@ type AppsListAccountsUserOrOrgOnPlanEndpoint = { */ page?: number; }; -type AppsListAccountsUserOrOrgOnPlanRequestOptions = { + +type AppsListAccountsForPlanRequestOptions = { method: "GET"; - url: Url; + url: "/marketplace_listing/plans/:plan_id/accounts"; headers: RequestHeaders; request: RequestRequestOptions; }; -type AppsCheckAccountIsAssociatedWithAnyStubbedEndpoint = { +type AppsListAccountsForPlanResponseDataItemMarketplacePurchasePlan = { + url: string; + accounts_url: string; + id: number; + number: number; + name: string; + description: string; + monthly_price_in_cents: number; + yearly_price_in_cents: number; + price_model: string; + has_free_trial: boolean; + unit_name: null; + state: string; + bullets: Array; +}; +type AppsListAccountsForPlanResponseDataItemMarketplacePurchase = { + billing_cycle: string; + next_billing_date: string; + unit_count: null; + on_free_trial: boolean; + free_trial_ends_on: string; + updated_at: string; + plan: AppsListAccountsForPlanResponseDataItemMarketplacePurchasePlan; +}; +type AppsListAccountsForPlanResponseDataItemMarketplacePendingChangePlan = { + url: string; + accounts_url: string; + id: number; + number: number; + name: string; + description: string; + monthly_price_in_cents: number; + yearly_price_in_cents: number; + price_model: string; + has_free_trial: boolean; + state: string; + unit_name: null; + bullets: Array; +}; +type AppsListAccountsForPlanResponseDataItemMarketplacePendingChange = { + effective_date: string; + unit_count: null; + id: number; + plan: AppsListAccountsForPlanResponseDataItemMarketplacePendingChangePlan; +}; +type AppsListAccountsForPlanResponseDataItem = { + url: string; + type: string; + id: number; + login: string; + email: null; + organization_billing_email: string; + marketplace_pending_change: AppsListAccountsForPlanResponseDataItemMarketplacePendingChange; + marketplace_purchase: AppsListAccountsForPlanResponseDataItemMarketplacePurchase; +}; +type AppsListAccountsForPlanResponseData = Array< + AppsListAccountsForPlanResponseDataItem +>; + +type AppsGetSubscriptionPlanForAccountStubbedEndpoint = { /** * account_id parameter */ account_id: number; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; }; -type AppsCheckAccountIsAssociatedWithAnyStubbedRequestOptions = { + +type AppsGetSubscriptionPlanForAccountStubbedRequestOptions = { method: "GET"; - url: Url; + url: "/marketplace_listing/stubbed/accounts/:account_id"; headers: RequestHeaders; request: RequestRequestOptions; }; +type AppsGetSubscriptionPlanForAccountStubbedResponseDataMarketplacePurchasePlan = { + url: string; + accounts_url: string; + id: number; + number: number; + name: string; + description: string; + monthly_price_in_cents: number; + yearly_price_in_cents: number; + price_model: string; + has_free_trial: boolean; + unit_name: null; + state: string; + bullets: Array; +}; +type AppsGetSubscriptionPlanForAccountStubbedResponseDataMarketplacePurchase = { + billing_cycle: string; + next_billing_date: string; + unit_count: null; + on_free_trial: boolean; + free_trial_ends_on: string; + updated_at: string; + plan: AppsGetSubscriptionPlanForAccountStubbedResponseDataMarketplacePurchasePlan; +}; +type AppsGetSubscriptionPlanForAccountStubbedResponseDataMarketplacePendingChangePlan = { + url: string; + accounts_url: string; + id: number; + number: number; + name: string; + description: string; + monthly_price_in_cents: number; + yearly_price_in_cents: number; + price_model: string; + has_free_trial: boolean; + state: string; + unit_name: null; + bullets: Array; +}; +type AppsGetSubscriptionPlanForAccountStubbedResponseDataMarketplacePendingChange = { + effective_date: string; + unit_count: null; + id: number; + plan: AppsGetSubscriptionPlanForAccountStubbedResponseDataMarketplacePendingChangePlan; +}; +type AppsGetSubscriptionPlanForAccountStubbedResponseData = { + url: string; + type: string; + id: number; + login: string; + email: null; + organization_billing_email: string; + marketplace_pending_change: AppsGetSubscriptionPlanForAccountStubbedResponseDataMarketplacePendingChange; + marketplace_purchase: AppsGetSubscriptionPlanForAccountStubbedResponseDataMarketplacePurchase; +}; + type AppsListPlansStubbedEndpoint = { /** * Results per page (max 100) @@ -3109,13 +8541,33 @@ type AppsListPlansStubbedEndpoint = { */ page?: number; }; + type AppsListPlansStubbedRequestOptions = { method: "GET"; - url: Url; + url: "/marketplace_listing/stubbed/plans"; headers: RequestHeaders; request: RequestRequestOptions; }; -type AppsListAccountsUserOrOrgOnPlanStubbedEndpoint = { +type AppsListPlansStubbedResponseDataItem = { + url: string; + accounts_url: string; + id: number; + number: number; + name: string; + description: string; + monthly_price_in_cents: number; + yearly_price_in_cents: number; + price_model: string; + has_free_trial: boolean; + unit_name: null; + state: string; + bullets: Array; +}; +type AppsListPlansStubbedResponseData = Array< + AppsListPlansStubbedResponseDataItem +>; + +type AppsListAccountsForPlanStubbedEndpoint = { /** * plan_id parameter */ @@ -3137,19 +8589,97 @@ type AppsListAccountsUserOrOrgOnPlanStubbedEndpoint = { */ page?: number; }; -type AppsListAccountsUserOrOrgOnPlanStubbedRequestOptions = { + +type AppsListAccountsForPlanStubbedRequestOptions = { method: "GET"; - url: Url; + url: "/marketplace_listing/stubbed/plans/:plan_id/accounts"; headers: RequestHeaders; request: RequestRequestOptions; }; +type AppsListAccountsForPlanStubbedResponseDataItemMarketplacePurchasePlan = { + url: string; + accounts_url: string; + id: number; + number: number; + name: string; + description: string; + monthly_price_in_cents: number; + yearly_price_in_cents: number; + price_model: string; + has_free_trial: boolean; + unit_name: null; + state: string; + bullets: Array; +}; +type AppsListAccountsForPlanStubbedResponseDataItemMarketplacePurchase = { + billing_cycle: string; + next_billing_date: string; + unit_count: null; + on_free_trial: boolean; + free_trial_ends_on: string; + updated_at: string; + plan: AppsListAccountsForPlanStubbedResponseDataItemMarketplacePurchasePlan; +}; +type AppsListAccountsForPlanStubbedResponseDataItemMarketplacePendingChangePlan = { + url: string; + accounts_url: string; + id: number; + number: number; + name: string; + description: string; + monthly_price_in_cents: number; + yearly_price_in_cents: number; + price_model: string; + has_free_trial: boolean; + state: string; + unit_name: null; + bullets: Array; +}; +type AppsListAccountsForPlanStubbedResponseDataItemMarketplacePendingChange = { + effective_date: string; + unit_count: null; + id: number; + plan: AppsListAccountsForPlanStubbedResponseDataItemMarketplacePendingChangePlan; +}; +type AppsListAccountsForPlanStubbedResponseDataItem = { + url: string; + type: string; + id: number; + login: string; + email: null; + organization_billing_email: string; + marketplace_pending_change: AppsListAccountsForPlanStubbedResponseDataItemMarketplacePendingChange; + marketplace_purchase: AppsListAccountsForPlanStubbedResponseDataItemMarketplacePurchase; +}; +type AppsListAccountsForPlanStubbedResponseData = Array< + AppsListAccountsForPlanStubbedResponseDataItem +>; + type MetaGetEndpoint = {}; + type MetaGetRequestOptions = { method: "GET"; - url: Url; + url: "/meta"; headers: RequestHeaders; request: RequestRequestOptions; }; +type MetaGetResponseDataSshKeyFingerprints = { + MD5_RSA: string; + MD5_DSA: string; + SHA256_RSA: string; + SHA256_DSA: string; +}; +type MetaGetResponseData = { + verifiable_password_authentication: boolean; + ssh_key_fingerprints: MetaGetResponseDataSshKeyFingerprints; + hooks: Array; + web: Array; + api: Array; + git: Array; + pages: Array; + importer: Array; +}; + type ActivityListPublicEventsForRepoNetworkEndpoint = { /** * owner parameter @@ -3168,13 +8698,15 @@ type ActivityListPublicEventsForRepoNetworkEndpoint = { */ page?: number; }; + type ActivityListPublicEventsForRepoNetworkRequestOptions = { method: "GET"; - url: Url; + url: "/networks/:owner/:repo/events"; headers: RequestHeaders; request: RequestRequestOptions; }; -type ActivityListNotificationsEndpoint = { + +type ActivityListNotificationsForAuthenticatedUserEndpoint = { /** * If `true`, show notifications marked as read. */ @@ -3200,60 +8732,251 @@ type ActivityListNotificationsEndpoint = { */ page?: number; }; -type ActivityListNotificationsRequestOptions = { + +type ActivityListNotificationsForAuthenticatedUserRequestOptions = { method: "GET"; - url: Url; + url: "/notifications"; headers: RequestHeaders; request: RequestRequestOptions; }; -type ActivityMarkAsReadEndpoint = { +type ActivityListNotificationsForAuthenticatedUserResponseDataItemSubject = { + title: string; + url: string; + latest_comment_url: string; + type: string; +}; +type ActivityListNotificationsForAuthenticatedUserResponseDataItemRepositoryOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ActivityListNotificationsForAuthenticatedUserResponseDataItemRepository = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: ActivityListNotificationsForAuthenticatedUserResponseDataItemRepositoryOwner; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; +}; +type ActivityListNotificationsForAuthenticatedUserResponseDataItem = { + id: string; + repository: ActivityListNotificationsForAuthenticatedUserResponseDataItemRepository; + subject: ActivityListNotificationsForAuthenticatedUserResponseDataItemSubject; + reason: string; + unread: boolean; + updated_at: string; + last_read_at: string; + url: string; +}; +type ActivityListNotificationsForAuthenticatedUserResponseData = Array< + ActivityListNotificationsForAuthenticatedUserResponseDataItem +>; + +type ActivityMarkNotificationsAsReadEndpoint = { /** - * Describes the last point that notifications were checked. Anything updated since this time will not be updated. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp. + * Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp. */ last_read_at?: string; }; -type ActivityMarkAsReadRequestOptions = { + +type ActivityMarkNotificationsAsReadRequestOptions = { method: "PUT"; - url: Url; + url: "/notifications"; headers: RequestHeaders; request: RequestRequestOptions; }; + type ActivityGetThreadEndpoint = { /** * thread_id parameter */ thread_id: number; }; + type ActivityGetThreadRequestOptions = { method: "GET"; - url: Url; + url: "/notifications/threads/:thread_id"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ActivityGetThreadResponseDataSubject = { + title: string; + url: string; + latest_comment_url: string; + type: string; +}; +type ActivityGetThreadResponseDataRepositoryOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ActivityGetThreadResponseDataRepository = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: ActivityGetThreadResponseDataRepositoryOwner; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; +}; +type ActivityGetThreadResponseData = { + id: string; + repository: ActivityGetThreadResponseDataRepository; + subject: ActivityGetThreadResponseDataSubject; + reason: string; + unread: boolean; + updated_at: string; + last_read_at: string; + url: string; +}; + type ActivityMarkThreadAsReadEndpoint = { /** * thread_id parameter */ thread_id: number; }; + type ActivityMarkThreadAsReadRequestOptions = { method: "PATCH"; - url: Url; + url: "/notifications/threads/:thread_id"; headers: RequestHeaders; request: RequestRequestOptions; }; -type ActivityGetThreadSubscriptionEndpoint = { + +type ActivityGetThreadSubscriptionForAuthenticatedUserEndpoint = { /** * thread_id parameter */ thread_id: number; }; -type ActivityGetThreadSubscriptionRequestOptions = { + +type ActivityGetThreadSubscriptionForAuthenticatedUserRequestOptions = { method: "GET"; - url: Url; + url: "/notifications/threads/:thread_id/subscription"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ActivityGetThreadSubscriptionForAuthenticatedUserResponseData = { + subscribed: boolean; + ignored: boolean; + reason: null; + created_at: string; + url: string; + thread_url: string; +}; + type ActivitySetThreadSubscriptionEndpoint = { /** * thread_id parameter @@ -3264,56 +8987,129 @@ type ActivitySetThreadSubscriptionEndpoint = { */ ignored?: boolean; }; + type ActivitySetThreadSubscriptionRequestOptions = { method: "PUT"; - url: Url; + url: "/notifications/threads/:thread_id/subscription"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ActivitySetThreadSubscriptionResponseData = { + subscribed: boolean; + ignored: boolean; + reason: null; + created_at: string; + url: string; + thread_url: string; +}; + type ActivityDeleteThreadSubscriptionEndpoint = { /** * thread_id parameter */ thread_id: number; }; + type ActivityDeleteThreadSubscriptionRequestOptions = { method: "DELETE"; - url: Url; + url: "/notifications/threads/:thread_id/subscription"; headers: RequestHeaders; request: RequestRequestOptions; }; + type OrgsListEndpoint = { /** - * The integer ID of the last Organization that you've seen. + * The integer ID of the last organization that you've seen. */ - since?: string; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; + since?: number; }; + type OrgsListRequestOptions = { method: "GET"; - url: Url; + url: "/organizations"; headers: RequestHeaders; request: RequestRequestOptions; }; +type OrgsListResponseDataItem = { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; +}; +type OrgsListResponseData = Array; + type OrgsGetEndpoint = { /** * org parameter */ org: string; }; + type OrgsGetRequestOptions = { method: "GET"; - url: Url; + url: "/orgs/:org"; headers: RequestHeaders; request: RequestRequestOptions; }; +type OrgsGetResponseDataPlan = { + name: string; + space: number; + private_repos: number; + filled_seats?: number; + seats?: number; +}; +type OrgsGetResponseData = { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; + name: string; + company: string; + blog: string; + location: string; + email: string; + is_verified: boolean; + has_organization_projects: boolean; + has_repository_projects: boolean; + public_repos: number; + public_gists: number; + followers: number; + following: number; + html_url: string; + created_at: string; + type: string; + total_private_repos?: number; + owned_private_repos?: number; + private_gists?: number; + disk_usage?: number; + collaborators?: number; + billing_email?: string; + plan: OrgsGetResponseDataPlan; + default_repository_permission?: string; + members_can_create_repositories?: boolean; + two_factor_requirement_enabled?: boolean; + members_allowed_repository_creation_type?: string; + members_can_create_public_repositories?: boolean; + members_can_create_private_repositories?: boolean; + members_can_create_internal_repositories?: boolean; +}; + type OrgsUpdateEndpoint = { /** * org parameter @@ -3344,11 +9140,11 @@ type OrgsUpdateEndpoint = { */ description?: string; /** - * Toggles whether organization projects are enabled for the organization. + * Toggles whether an organization can use organization projects. */ has_organization_projects?: boolean; /** - * Toggles whether repository projects are enabled for repositories that belong to the organization. + * Toggles whether repositories that belong to the organization can use repository projects. */ has_repository_projects?: boolean; /** @@ -3362,115 +9158,98 @@ type OrgsUpdateEndpoint = { /** * Toggles the ability of non-admin organization members to create repositories. Can be one of: * \* `true` - all organization members can create repositories. - * \* `false` - only admin members can create repositories. + * \* `false` - only organization owners can create repositories. * Default: `true` - * **Note:** Another parameter can override the this parameter. See [this note](https://developer.github.com/v3/orgs/#members_can_create_repositories) for details. **Note:** Another parameter can override the this parameter. See [this note](https://developer.github.com/v3/orgs/#members_can_create_repositories) for details. + * **Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details. **Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details. */ members_can_create_repositories?: boolean; + /** + * Toggles whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. Can be one of: + * \* `true` - all organization members can create internal repositories. + * \* `false` - only organization owners can create internal repositories. + * Default: `true`. For more information, see "[Restricting repository creation in your organization](https://help.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. + */ + members_can_create_internal_repositories?: boolean; + /** + * Toggles whether organization members can create private repositories, which are visible to organization members with permission. Can be one of: + * \* `true` - all organization members can create private repositories. + * \* `false` - only organization owners can create private repositories. + * Default: `true`. For more information, see "[Restricting repository creation in your organization](https://help.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. + */ + members_can_create_private_repositories?: boolean; + /** + * Toggles whether organization members can create public repositories, which are visible to anyone. Can be one of: + * \* `true` - all organization members can create public repositories. + * \* `false` - only organization owners can create public repositories. + * Default: `true`. For more information, see "[Restricting repository creation in your organization](https://help.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. + */ + members_can_create_public_repositories?: boolean; /** * Specifies which types of repositories non-admin organization members can create. Can be one of: * \* `all` - all organization members can create public and private repositories. - * \* `private` - members can create private repositories. This option is only available to repositories that are part of an organization on [GitHub Business Cloud](https://github.com/pricing/business-cloud). + * \* `private` - members can create private repositories. This option is only available to repositories that are part of an organization on GitHub Enterprise Cloud. * \* `none` - only admin members can create repositories. - * **Note:** Using this parameter will override values set in `members_can_create_repositories`. See [this note](https://developer.github.com/v3/orgs/#members_can_create_repositories) for details. + * **Note:** This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See [this note](https://developer.github.com/v3/orgs/#members_can_create_repositories) for details. */ members_allowed_repository_creation_type?: "all" | "private" | "none"; }; + type OrgsUpdateRequestOptions = { method: "PATCH"; - url: Url; + url: "/orgs/:org"; headers: RequestHeaders; request: RequestRequestOptions; }; -type OrgsListBlockedUsersEndpoint = { - /** - * org parameter - */ - org: string; +type OrgsUpdateResponseDataPlan = { + name: string; + space: number; + private_repos: number; }; -type OrgsListBlockedUsersRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; +type OrgsUpdateResponseData = { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; + name: string; + company: string; + blog: string; + location: string; + email: string; + is_verified: boolean; + has_organization_projects: boolean; + has_repository_projects: boolean; + public_repos: number; + public_gists: number; + followers: number; + following: number; + html_url: string; + created_at: string; + type: string; + total_private_repos: number; + owned_private_repos: number; + private_gists: number; + disk_usage: number; + collaborators: number; + billing_email: string; + plan: OrgsUpdateResponseDataPlan; + default_repository_permission: string; + members_can_create_repositories: boolean; + two_factor_requirement_enabled: boolean; + members_allowed_repository_creation_type: string; + members_can_create_public_repositories: boolean; + members_can_create_private_repositories: boolean; + members_can_create_internal_repositories: boolean; }; -type OrgsCheckBlockedUserEndpoint = { - /** - * org parameter - */ - org: string; - /** - * username parameter - */ - username: string; -}; -type OrgsCheckBlockedUserRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type OrgsBlockUserEndpoint = { - /** - * org parameter - */ - org: string; - /** - * username parameter - */ - username: string; -}; -type OrgsBlockUserRequestOptions = { - method: "PUT"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type OrgsUnblockUserEndpoint = { - /** - * org parameter - */ - org: string; - /** - * username parameter - */ - username: string; -}; -type OrgsUnblockUserRequestOptions = { - method: "DELETE"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type OrgsListCredentialAuthorizationsEndpoint = { - /** - * org parameter - */ - org: string; -}; -type OrgsListCredentialAuthorizationsRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type OrgsRemoveCredentialAuthorizationEndpoint = { - /** - * org parameter - */ - org: string; - /** - * credential_id parameter - */ - credential_id: number; -}; -type OrgsRemoveCredentialAuthorizationRequestOptions = { - method: "DELETE"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ActivityListPublicEventsForOrgEndpoint = { + +type ActionsListSelfHostedRunnersForOrgEndpoint = { /** * org parameter */ @@ -3484,12 +9263,281 @@ type ActivityListPublicEventsForOrgEndpoint = { */ page?: number; }; -type ActivityListPublicEventsForOrgRequestOptions = { + +type ActionsListSelfHostedRunnersForOrgRequestOptions = { method: "GET"; - url: Url; + url: "/orgs/:org/actions/runners"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ActionsListSelfHostedRunnersForOrgResponseDataRunnersItem = { + id: number; + name: string; + os: string; + status: string; +}; +type ActionsListSelfHostedRunnersForOrgResponseData = { + total_count: number; + runners: Array; +}; + +type ActionsListRunnerApplicationsForOrgEndpoint = { + /** + * org parameter + */ + org: string; +}; + +type ActionsListRunnerApplicationsForOrgRequestOptions = { + method: "GET"; + url: "/orgs/:org/actions/runners/downloads"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActionsListRunnerApplicationsForOrgResponseDataItem = { + os: string; + architecture: string; + download_url: string; + filename: string; +}; +type ActionsListRunnerApplicationsForOrgResponseData = Array< + ActionsListRunnerApplicationsForOrgResponseDataItem +>; + +type ActionsCreateRegistrationTokenForOrgEndpoint = { + /** + * org parameter + */ + org: string; +}; + +type ActionsCreateRegistrationTokenForOrgRequestOptions = { + method: "POST"; + url: "/orgs/:org/actions/runners/registration-token"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActionsCreateRegistrationTokenForOrgResponseData = { + token: string; + expires_at: string; +}; + +type ActionsCreateRemoveTokenForOrgEndpoint = { + /** + * org parameter + */ + org: string; +}; + +type ActionsCreateRemoveTokenForOrgRequestOptions = { + method: "POST"; + url: "/orgs/:org/actions/runners/remove-token"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActionsCreateRemoveTokenForOrgResponseData = { + token: string; + expires_at: string; +}; + +type ActionsGetSelfHostedRunnerForOrgEndpoint = { + /** + * org parameter + */ + org: string; + /** + * runner_id parameter + */ + runner_id: number; +}; + +type ActionsGetSelfHostedRunnerForOrgRequestOptions = { + method: "GET"; + url: "/orgs/:org/actions/runners/:runner_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActionsGetSelfHostedRunnerForOrgResponseData = { + id: number; + name: string; + os: string; + status: string; +}; + +type ActionsDeleteSelfHostedRunnerFromOrgEndpoint = { + /** + * org parameter + */ + org: string; + /** + * runner_id parameter + */ + runner_id: number; +}; + +type ActionsDeleteSelfHostedRunnerFromOrgRequestOptions = { + method: "DELETE"; + url: "/orgs/:org/actions/runners/:runner_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; + +type OrgsListBlockedUsersEndpoint = { + /** + * org parameter + */ + org: string; +}; + +type OrgsListBlockedUsersRequestOptions = { + method: "GET"; + url: "/orgs/:org/blocks"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsListBlockedUsersResponseDataItem = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type OrgsListBlockedUsersResponseData = Array< + OrgsListBlockedUsersResponseDataItem +>; + +type OrgsCheckBlockedUserEndpoint = { + /** + * org parameter + */ + org: string; + /** + * username parameter + */ + username: string; +}; + +type OrgsCheckBlockedUserRequestOptions = { + method: "GET"; + url: "/orgs/:org/blocks/:username"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; + +type OrgsBlockUserEndpoint = { + /** + * org parameter + */ + org: string; + /** + * username parameter + */ + username: string; +}; + +type OrgsBlockUserRequestOptions = { + method: "PUT"; + url: "/orgs/:org/blocks/:username"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; + +type OrgsUnblockUserEndpoint = { + /** + * org parameter + */ + org: string; + /** + * username parameter + */ + username: string; +}; + +type OrgsUnblockUserRequestOptions = { + method: "DELETE"; + url: "/orgs/:org/blocks/:username"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; + +type OrgsListCredentialAuthorizationsEndpoint = { + /** + * org parameter + */ + org: string; +}; + +type OrgsListCredentialAuthorizationsRequestOptions = { + method: "GET"; + url: "/orgs/:org/credential-authorizations"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsListCredentialAuthorizationsResponseDataItem = { + login: string; + credential_id: string; + credential_type: string; + token_last_eight: string; + credential_authorized_at: string; + scopes: Array; +}; +type OrgsListCredentialAuthorizationsResponseData = Array< + OrgsListCredentialAuthorizationsResponseDataItem +>; + +type OrgsRemoveCredentialAuthorizationEndpoint = { + /** + * org parameter + */ + org: string; + /** + * credential_id parameter + */ + credential_id: number; +}; + +type OrgsRemoveCredentialAuthorizationRequestOptions = { + method: "DELETE"; + url: "/orgs/:org/credential-authorizations/:credential_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; + +type ActivityListPublicOrgEventsEndpoint = { + /** + * org parameter + */ + org: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; + +type ActivityListPublicOrgEventsRequestOptions = { + method: "GET"; + url: "/orgs/:org/events"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; + type OrgsListHooksEndpoint = { /** * org parameter @@ -3504,12 +9552,30 @@ type OrgsListHooksEndpoint = { */ page?: number; }; + type OrgsListHooksRequestOptions = { method: "GET"; - url: Url; + url: "/orgs/:org/hooks"; headers: RequestHeaders; request: RequestRequestOptions; }; +type OrgsListHooksResponseDataItemConfig = { + url: string; + content_type: string; +}; +type OrgsListHooksResponseDataItem = { + id: number; + url: string; + ping_url: string; + name: string; + events: Array; + active: boolean; + config: OrgsListHooksResponseDataItemConfig; + updated_at: string; + created_at: string; +}; +type OrgsListHooksResponseData = Array; + type OrgsCreateHookEndpoint = { /** * org parameter @@ -3532,12 +9598,26 @@ type OrgsCreateHookEndpoint = { */ active?: boolean; }; + type OrgsCreateHookRequestOptions = { method: "POST"; - url: Url; + url: "/orgs/:org/hooks"; headers: RequestHeaders; request: RequestRequestOptions; }; +type OrgsCreateHookResponseDataConfig = { url: string; content_type: string }; +type OrgsCreateHookResponseData = { + id: number; + url: string; + ping_url: string; + name: string; + events: Array; + active: boolean; + config: OrgsCreateHookResponseDataConfig; + updated_at: string; + created_at: string; +}; + type OrgsGetHookEndpoint = { /** * org parameter @@ -3548,12 +9628,26 @@ type OrgsGetHookEndpoint = { */ hook_id: number; }; + type OrgsGetHookRequestOptions = { method: "GET"; - url: Url; + url: "/orgs/:org/hooks/:hook_id"; headers: RequestHeaders; request: RequestRequestOptions; }; +type OrgsGetHookResponseDataConfig = { url: string; content_type: string }; +type OrgsGetHookResponseData = { + id: number; + url: string; + ping_url: string; + name: string; + events: Array; + active: boolean; + config: OrgsGetHookResponseDataConfig; + updated_at: string; + created_at: string; +}; + type OrgsUpdateHookEndpoint = { /** * org parameter @@ -3576,12 +9670,26 @@ type OrgsUpdateHookEndpoint = { */ active?: boolean; }; + type OrgsUpdateHookRequestOptions = { method: "PATCH"; - url: Url; + url: "/orgs/:org/hooks/:hook_id"; headers: RequestHeaders; request: RequestRequestOptions; }; +type OrgsUpdateHookResponseDataConfig = { url: string; content_type: string }; +type OrgsUpdateHookResponseData = { + id: number; + url: string; + ping_url: string; + name: string; + events: Array; + active: boolean; + config: OrgsUpdateHookResponseDataConfig; + updated_at: string; + created_at: string; +}; + type OrgsDeleteHookEndpoint = { /** * org parameter @@ -3592,12 +9700,14 @@ type OrgsDeleteHookEndpoint = { */ hook_id: number; }; + type OrgsDeleteHookRequestOptions = { method: "DELETE"; - url: Url; + url: "/orgs/:org/hooks/:hook_id"; headers: RequestHeaders; request: RequestRequestOptions; }; + type OrgsPingHookEndpoint = { /** * org parameter @@ -3608,48 +9718,155 @@ type OrgsPingHookEndpoint = { */ hook_id: number; }; + type OrgsPingHookRequestOptions = { method: "POST"; - url: Url; + url: "/orgs/:org/hooks/:hook_id/pings"; headers: RequestHeaders; request: RequestRequestOptions; }; + type AppsGetOrgInstallationEndpoint = { /** * org parameter */ org: string; -}; +} & RequiredPreview<"machine-man">; + type AppsGetOrgInstallationRequestOptions = { method: "GET"; - url: Url; + url: "/orgs/:org/installation"; headers: RequestHeaders; request: RequestRequestOptions; }; -type AppsFindOrgInstallationEndpoint = { +type AppsGetOrgInstallationResponseDataPermissions = { + checks: string; + metadata: string; + contents: string; +}; +type AppsGetOrgInstallationResponseDataAccount = { + login: string; + id: number; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type AppsGetOrgInstallationResponseData = { + id: number; + account: AppsGetOrgInstallationResponseDataAccount; + repository_selection: string; + access_tokens_url: string; + repositories_url: string; + html_url: string; + app_id: number; + target_id: number; + target_type: string; + permissions: AppsGetOrgInstallationResponseDataPermissions; + events: Array; + created_at: string; + updated_at: string; + single_file_name: null; +}; + +type OrgsListInstallationsEndpoint = { /** * org parameter */ org: string; -}; -type AppsFindOrgInstallationRequestOptions = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +} & RequiredPreview<"machine-man">; + +type OrgsListInstallationsRequestOptions = { method: "GET"; - url: Url; + url: "/orgs/:org/installations"; headers: RequestHeaders; request: RequestRequestOptions; }; +type OrgsListInstallationsResponseDataInstallationsItemPermissions = { + deployments: string; + metadata: string; + pull_requests: string; + statuses: string; +}; +type OrgsListInstallationsResponseDataInstallationsItemAccount = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type OrgsListInstallationsResponseDataInstallationsItem = { + id: number; + account: OrgsListInstallationsResponseDataInstallationsItemAccount; + repository_selection: string; + access_tokens_url: string; + repositories_url: string; + html_url: string; + app_id: number; + target_id: number; + target_type: string; + permissions: OrgsListInstallationsResponseDataInstallationsItemPermissions; + events: Array; + created_at: string; + updated_at: string; + single_file_name: null; +}; +type OrgsListInstallationsResponseData = { + total_count: number; + installations: Array; +}; + type InteractionsGetRestrictionsForOrgEndpoint = { /** * org parameter */ org: string; -}; +} & RequiredPreview<"sombra">; + type InteractionsGetRestrictionsForOrgRequestOptions = { method: "GET"; - url: Url; + url: "/orgs/:org/interaction-limits"; headers: RequestHeaders; request: RequestRequestOptions; }; +type InteractionsGetRestrictionsForOrgResponseData = { + limit: string; + origin: string; + expires_at: string; +}; + type InteractionsAddOrUpdateRestrictionsForOrgEndpoint = { /** * org parameter @@ -3659,25 +9876,34 @@ type InteractionsAddOrUpdateRestrictionsForOrgEndpoint = { * Specifies the group of GitHub users who can comment, open issues, or create pull requests in public repositories for the given organization. Must be one of: `existing_users`, `contributors_only`, or `collaborators_only`. */ limit: "existing_users" | "contributors_only" | "collaborators_only"; -}; +} & RequiredPreview<"sombra">; + type InteractionsAddOrUpdateRestrictionsForOrgRequestOptions = { method: "PUT"; - url: Url; + url: "/orgs/:org/interaction-limits"; headers: RequestHeaders; request: RequestRequestOptions; }; +type InteractionsAddOrUpdateRestrictionsForOrgResponseData = { + limit: string; + origin: string; + expires_at: string; +}; + type InteractionsRemoveRestrictionsForOrgEndpoint = { /** * org parameter */ org: string; -}; +} & RequiredPreview<"sombra">; + type InteractionsRemoveRestrictionsForOrgRequestOptions = { method: "DELETE"; - url: Url; + url: "/orgs/:org/interaction-limits"; headers: RequestHeaders; request: RequestRequestOptions; }; + type OrgsListPendingInvitationsEndpoint = { /** * org parameter @@ -3692,12 +9918,47 @@ type OrgsListPendingInvitationsEndpoint = { */ page?: number; }; + type OrgsListPendingInvitationsRequestOptions = { method: "GET"; - url: Url; + url: "/orgs/:org/invitations"; headers: RequestHeaders; request: RequestRequestOptions; }; +type OrgsListPendingInvitationsResponseDataItemInviter = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type OrgsListPendingInvitationsResponseDataItem = { + id: number; + login: string; + email: string; + role: string; + created_at: string; + inviter: OrgsListPendingInvitationsResponseDataItemInviter; + team_count: number; + invitation_team_url: string; +}; +type OrgsListPendingInvitationsResponseData = Array< + OrgsListPendingInvitationsResponseDataItem +>; + type OrgsCreateInvitationEndpoint = { /** * org parameter @@ -3723,12 +9984,44 @@ type OrgsCreateInvitationEndpoint = { */ team_ids?: number[]; }; + type OrgsCreateInvitationRequestOptions = { method: "POST"; - url: Url; + url: "/orgs/:org/invitations"; headers: RequestHeaders; request: RequestRequestOptions; }; +type OrgsCreateInvitationResponseDataInviter = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type OrgsCreateInvitationResponseData = { + id: number; + login: string; + email: string; + role: string; + created_at: string; + inviter: OrgsCreateInvitationResponseDataInviter; + team_count: number; + invitation_team_url: string; +}; + type OrgsListInvitationTeamsEndpoint = { /** * org parameter @@ -3747,12 +10040,31 @@ type OrgsListInvitationTeamsEndpoint = { */ page?: number; }; + type OrgsListInvitationTeamsRequestOptions = { method: "GET"; - url: Url; + url: "/orgs/:org/invitations/:invitation_id/teams"; headers: RequestHeaders; request: RequestRequestOptions; }; +type OrgsListInvitationTeamsResponseDataItem = { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: null; +}; +type OrgsListInvitationTeamsResponseData = Array< + OrgsListInvitationTeamsResponseDataItem +>; + type IssuesListForOrgEndpoint = { /** * org parameter @@ -3796,12 +10108,262 @@ type IssuesListForOrgEndpoint = { */ page?: number; }; + type IssuesListForOrgRequestOptions = { method: "GET"; - url: Url; + url: "/orgs/:org/issues"; headers: RequestHeaders; request: RequestRequestOptions; }; +type IssuesListForOrgResponseDataItemRepositoryPermissions = { + admin: boolean; + push: boolean; + pull: boolean; +}; +type IssuesListForOrgResponseDataItemRepositoryOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type IssuesListForOrgResponseDataItemRepository = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: IssuesListForOrgResponseDataItemRepositoryOwner; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: null; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: Array; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: IssuesListForOrgResponseDataItemRepositoryPermissions; + allow_rebase_merge: boolean; + template_repository: null; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; +}; +type IssuesListForOrgResponseDataItemPullRequest = { + url: string; + html_url: string; + diff_url: string; + patch_url: string; +}; +type IssuesListForOrgResponseDataItemMilestoneCreator = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type IssuesListForOrgResponseDataItemMilestone = { + url: string; + html_url: string; + labels_url: string; + id: number; + node_id: string; + number: number; + state: string; + title: string; + description: string; + creator: IssuesListForOrgResponseDataItemMilestoneCreator; + open_issues: number; + closed_issues: number; + created_at: string; + updated_at: string; + closed_at: string; + due_on: string; +}; +type IssuesListForOrgResponseDataItemAssigneesItem = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type IssuesListForOrgResponseDataItemAssignee = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type IssuesListForOrgResponseDataItemLabelsItem = { + id: number; + node_id: string; + url: string; + name: string; + description: string; + color: string; + default: boolean; +}; +type IssuesListForOrgResponseDataItemUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type IssuesListForOrgResponseDataItem = { + id: number; + node_id: string; + url: string; + repository_url: string; + labels_url: string; + comments_url: string; + events_url: string; + html_url: string; + number: number; + state: string; + title: string; + body: string; + user: IssuesListForOrgResponseDataItemUser; + labels: Array; + assignee: IssuesListForOrgResponseDataItemAssignee; + assignees: Array; + milestone: IssuesListForOrgResponseDataItemMilestone; + locked: boolean; + active_lock_reason: string; + comments: number; + pull_request: IssuesListForOrgResponseDataItemPullRequest; + closed_at: null; + created_at: string; + updated_at: string; + repository: IssuesListForOrgResponseDataItemRepository; +}; +type IssuesListForOrgResponseData = Array; + type OrgsListMembersEndpoint = { /** * org parameter @@ -3829,12 +10391,35 @@ type OrgsListMembersEndpoint = { */ page?: number; }; + type OrgsListMembersRequestOptions = { method: "GET"; - url: Url; + url: "/orgs/:org/members"; headers: RequestHeaders; request: RequestRequestOptions; }; +type OrgsListMembersResponseDataItem = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type OrgsListMembersResponseData = Array; + type OrgsCheckMembershipEndpoint = { /** * org parameter @@ -3845,12 +10430,14 @@ type OrgsCheckMembershipEndpoint = { */ username: string; }; + type OrgsCheckMembershipRequestOptions = { method: "GET"; - url: Url; + url: "/orgs/:org/members/:username"; headers: RequestHeaders; request: RequestRequestOptions; }; + type OrgsRemoveMemberEndpoint = { /** * org parameter @@ -3861,12 +10448,14 @@ type OrgsRemoveMemberEndpoint = { */ username: string; }; + type OrgsRemoveMemberRequestOptions = { method: "DELETE"; - url: Url; + url: "/orgs/:org/members/:username"; headers: RequestHeaders; request: RequestRequestOptions; }; + type OrgsGetMembershipEndpoint = { /** * org parameter @@ -3877,12 +10466,56 @@ type OrgsGetMembershipEndpoint = { */ username: string; }; + type OrgsGetMembershipRequestOptions = { method: "GET"; - url: Url; + url: "/orgs/:org/memberships/:username"; headers: RequestHeaders; request: RequestRequestOptions; }; +type OrgsGetMembershipResponseDataUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type OrgsGetMembershipResponseDataOrganization = { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; +}; +type OrgsGetMembershipResponseData = { + url: string; + state: string; + role: string; + organization_url: string; + organization: OrgsGetMembershipResponseDataOrganization; + user: OrgsGetMembershipResponseDataUser; +}; + type OrgsAddOrUpdateMembershipEndpoint = { /** * org parameter @@ -3899,12 +10532,56 @@ type OrgsAddOrUpdateMembershipEndpoint = { */ role?: "admin" | "member"; }; + type OrgsAddOrUpdateMembershipRequestOptions = { method: "PUT"; - url: Url; + url: "/orgs/:org/memberships/:username"; headers: RequestHeaders; request: RequestRequestOptions; }; +type OrgsAddOrUpdateMembershipResponseDataUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type OrgsAddOrUpdateMembershipResponseDataOrganization = { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; +}; +type OrgsAddOrUpdateMembershipResponseData = { + url: string; + state: string; + role: string; + organization_url: string; + organization: OrgsAddOrUpdateMembershipResponseDataOrganization; + user: OrgsAddOrUpdateMembershipResponseDataUser; +}; + type OrgsRemoveMembershipEndpoint = { /** * org parameter @@ -3915,12 +10592,14 @@ type OrgsRemoveMembershipEndpoint = { */ username: string; }; + type OrgsRemoveMembershipRequestOptions = { method: "DELETE"; - url: Url; + url: "/orgs/:org/memberships/:username"; headers: RequestHeaders; request: RequestRequestOptions; }; + type MigrationsStartForOrgEndpoint = { /** * org parameter @@ -3939,12 +10618,147 @@ type MigrationsStartForOrgEndpoint = { */ exclude_attachments?: boolean; }; + type MigrationsStartForOrgRequestOptions = { method: "POST"; - url: Url; + url: "/orgs/:org/migrations"; headers: RequestHeaders; request: RequestRequestOptions; }; +type MigrationsStartForOrgResponseDataRepositoriesItemPermissions = { + admin: boolean; + push: boolean; + pull: boolean; +}; +type MigrationsStartForOrgResponseDataRepositoriesItemOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type MigrationsStartForOrgResponseDataRepositoriesItem = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: MigrationsStartForOrgResponseDataRepositoriesItemOwner; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: null; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: Array; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: MigrationsStartForOrgResponseDataRepositoriesItemPermissions; + allow_rebase_merge: boolean; + template_repository: null; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; +}; +type MigrationsStartForOrgResponseDataOwner = { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; +}; +type MigrationsStartForOrgResponseData = { + id: number; + owner: MigrationsStartForOrgResponseDataOwner; + guid: string; + state: string; + lock_repositories: boolean; + exclude_attachments: boolean; + repositories: Array; + url: string; + created_at: string; + updated_at: string; +}; + type MigrationsListForOrgEndpoint = { /** * org parameter @@ -3958,13 +10772,151 @@ type MigrationsListForOrgEndpoint = { * Page number of the results to fetch. */ page?: number; -}; +} & RequiredPreview<"wyandotte">; + type MigrationsListForOrgRequestOptions = { method: "GET"; - url: Url; + url: "/orgs/:org/migrations"; headers: RequestHeaders; request: RequestRequestOptions; }; +type MigrationsListForOrgResponseDataItemRepositoriesItemPermissions = { + admin: boolean; + push: boolean; + pull: boolean; +}; +type MigrationsListForOrgResponseDataItemRepositoriesItemOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type MigrationsListForOrgResponseDataItemRepositoriesItem = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: MigrationsListForOrgResponseDataItemRepositoriesItemOwner; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: null; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: Array; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: MigrationsListForOrgResponseDataItemRepositoriesItemPermissions; + allow_rebase_merge: boolean; + template_repository: null; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; +}; +type MigrationsListForOrgResponseDataItemOwner = { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; +}; +type MigrationsListForOrgResponseDataItem = { + id: number; + owner: MigrationsListForOrgResponseDataItemOwner; + guid: string; + state: string; + lock_repositories: boolean; + exclude_attachments: boolean; + repositories: Array; + url: string; + created_at: string; + updated_at: string; +}; +type MigrationsListForOrgResponseData = Array< + MigrationsListForOrgResponseDataItem +>; + type MigrationsGetStatusForOrgEndpoint = { /** * org parameter @@ -3974,14 +10926,149 @@ type MigrationsGetStatusForOrgEndpoint = { * migration_id parameter */ migration_id: number; -}; +} & RequiredPreview<"wyandotte">; + type MigrationsGetStatusForOrgRequestOptions = { method: "GET"; - url: Url; + url: "/orgs/:org/migrations/:migration_id"; headers: RequestHeaders; request: RequestRequestOptions; }; -type MigrationsGetArchiveForOrgEndpoint = { +type MigrationsGetStatusForOrgResponseDataRepositoriesItemPermissions = { + admin: boolean; + push: boolean; + pull: boolean; +}; +type MigrationsGetStatusForOrgResponseDataRepositoriesItemOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type MigrationsGetStatusForOrgResponseDataRepositoriesItem = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: MigrationsGetStatusForOrgResponseDataRepositoriesItemOwner; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: null; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: Array; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: MigrationsGetStatusForOrgResponseDataRepositoriesItemPermissions; + allow_rebase_merge: boolean; + template_repository: null; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; +}; +type MigrationsGetStatusForOrgResponseDataOwner = { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; +}; +type MigrationsGetStatusForOrgResponseData = { + id: number; + owner: MigrationsGetStatusForOrgResponseDataOwner; + guid: string; + state: string; + lock_repositories: boolean; + exclude_attachments: boolean; + repositories: Array; + url: string; + created_at: string; + updated_at: string; +}; + +type MigrationsDownloadArchiveForOrgEndpoint = { /** * org parameter */ @@ -3990,13 +11077,15 @@ type MigrationsGetArchiveForOrgEndpoint = { * migration_id parameter */ migration_id: number; -}; -type MigrationsGetArchiveForOrgRequestOptions = { +} & RequiredPreview<"wyandotte">; + +type MigrationsDownloadArchiveForOrgRequestOptions = { method: "GET"; - url: Url; + url: "/orgs/:org/migrations/:migration_id/archive"; headers: RequestHeaders; request: RequestRequestOptions; }; + type MigrationsDeleteArchiveForOrgEndpoint = { /** * org parameter @@ -4006,13 +11095,15 @@ type MigrationsDeleteArchiveForOrgEndpoint = { * migration_id parameter */ migration_id: number; -}; +} & RequiredPreview<"wyandotte">; + type MigrationsDeleteArchiveForOrgRequestOptions = { method: "DELETE"; - url: Url; + url: "/orgs/:org/migrations/:migration_id/archive"; headers: RequestHeaders; request: RequestRequestOptions; }; + type MigrationsUnlockRepoForOrgEndpoint = { /** * org parameter @@ -4026,13 +11117,156 @@ type MigrationsUnlockRepoForOrgEndpoint = { * repo_name parameter */ repo_name: string; -}; +} & RequiredPreview<"wyandotte">; + type MigrationsUnlockRepoForOrgRequestOptions = { method: "DELETE"; - url: Url; + url: "/orgs/:org/migrations/:migration_id/repos/:repo_name/lock"; headers: RequestHeaders; request: RequestRequestOptions; }; + +type MigrationsListReposForOrgEndpoint = { + /** + * org parameter + */ + org: string; + /** + * migration_id parameter + */ + migration_id: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +} & RequiredPreview<"wyandotte">; + +type MigrationsListReposForOrgRequestOptions = { + method: "GET"; + url: "/orgs/:org/migrations/:migration_id/repositories"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type MigrationsListReposForOrgResponseDataItemLicense = { + key: string; + name: string; + spdx_id: string; + url: string; + node_id: string; +}; +type MigrationsListReposForOrgResponseDataItemPermissions = { + admin: boolean; + push: boolean; + pull: boolean; +}; +type MigrationsListReposForOrgResponseDataItemOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type MigrationsListReposForOrgResponseDataItem = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: MigrationsListReposForOrgResponseDataItemOwner; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: null; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: Array; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: MigrationsListReposForOrgResponseDataItemPermissions; + template_repository: null; + temp_clone_token: string; + subscribers_count: number; + network_count: number; + license: MigrationsListReposForOrgResponseDataItemLicense; +}; +type MigrationsListReposForOrgResponseData = Array< + MigrationsListReposForOrgResponseDataItem +>; + type OrgsListOutsideCollaboratorsEndpoint = { /** * org parameter @@ -4053,12 +11287,37 @@ type OrgsListOutsideCollaboratorsEndpoint = { */ page?: number; }; + type OrgsListOutsideCollaboratorsRequestOptions = { method: "GET"; - url: Url; + url: "/orgs/:org/outside_collaborators"; headers: RequestHeaders; request: RequestRequestOptions; }; +type OrgsListOutsideCollaboratorsResponseDataItem = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type OrgsListOutsideCollaboratorsResponseData = Array< + OrgsListOutsideCollaboratorsResponseDataItem +>; + type OrgsRemoveOutsideCollaboratorEndpoint = { /** * org parameter @@ -4069,12 +11328,18 @@ type OrgsRemoveOutsideCollaboratorEndpoint = { */ username: string; }; + type OrgsRemoveOutsideCollaboratorRequestOptions = { method: "DELETE"; - url: Url; + url: "/orgs/:org/outside_collaborators/:username"; headers: RequestHeaders; request: RequestRequestOptions; }; +type OrgsRemoveOutsideCollaboratorResponseData = { + message: string; + documentation_url: string; +}; + type OrgsConvertMemberToOutsideCollaboratorEndpoint = { /** * org parameter @@ -4085,12 +11350,18 @@ type OrgsConvertMemberToOutsideCollaboratorEndpoint = { */ username: string; }; + type OrgsConvertMemberToOutsideCollaboratorRequestOptions = { method: "PUT"; - url: Url; + url: "/orgs/:org/outside_collaborators/:username"; headers: RequestHeaders; request: RequestRequestOptions; }; +type OrgsConvertMemberToOutsideCollaboratorResponseData = { + message: string; + documentation_url: string; +}; + type ProjectsListForOrgEndpoint = { /** * org parameter @@ -4108,13 +11379,51 @@ type ProjectsListForOrgEndpoint = { * Page number of the results to fetch. */ page?: number; -}; +} & RequiredPreview<"inertia">; + type ProjectsListForOrgRequestOptions = { method: "GET"; - url: Url; + url: "/orgs/:org/projects"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ProjectsListForOrgResponseDataItemCreator = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ProjectsListForOrgResponseDataItem = { + owner_url: string; + url: string; + html_url: string; + columns_url: string; + id: number; + node_id: string; + name: string; + body: string; + number: number; + state: string; + creator: ProjectsListForOrgResponseDataItemCreator; + created_at: string; + updated_at: string; +}; +type ProjectsListForOrgResponseData = Array; + type ProjectsCreateForOrgEndpoint = { /** * org parameter @@ -4128,13 +11437,50 @@ type ProjectsCreateForOrgEndpoint = { * The description of the project. */ body?: string; -}; +} & RequiredPreview<"inertia">; + type ProjectsCreateForOrgRequestOptions = { method: "POST"; - url: Url; + url: "/orgs/:org/projects"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ProjectsCreateForOrgResponseDataCreator = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ProjectsCreateForOrgResponseData = { + owner_url: string; + url: string; + html_url: string; + columns_url: string; + id: number; + node_id: string; + name: string; + body: string; + number: number; + state: string; + creator: ProjectsCreateForOrgResponseDataCreator; + created_at: string; + updated_at: string; +}; + type OrgsListPublicMembersEndpoint = { /** * org parameter @@ -4149,12 +11495,37 @@ type OrgsListPublicMembersEndpoint = { */ page?: number; }; + type OrgsListPublicMembersRequestOptions = { method: "GET"; - url: Url; + url: "/orgs/:org/public_members"; headers: RequestHeaders; request: RequestRequestOptions; }; +type OrgsListPublicMembersResponseDataItem = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type OrgsListPublicMembersResponseData = Array< + OrgsListPublicMembersResponseDataItem +>; + type OrgsCheckPublicMembershipEndpoint = { /** * org parameter @@ -4165,12 +11536,14 @@ type OrgsCheckPublicMembershipEndpoint = { */ username: string; }; + type OrgsCheckPublicMembershipRequestOptions = { method: "GET"; - url: Url; + url: "/orgs/:org/public_members/:username"; headers: RequestHeaders; request: RequestRequestOptions; }; + type OrgsPublicizeMembershipEndpoint = { /** * org parameter @@ -4181,12 +11554,14 @@ type OrgsPublicizeMembershipEndpoint = { */ username: string; }; + type OrgsPublicizeMembershipRequestOptions = { method: "PUT"; - url: Url; + url: "/orgs/:org/public_members/:username"; headers: RequestHeaders; request: RequestRequestOptions; }; + type OrgsConcealMembershipEndpoint = { /** * org parameter @@ -4197,21 +11572,30 @@ type OrgsConcealMembershipEndpoint = { */ username: string; }; + type OrgsConcealMembershipRequestOptions = { method: "DELETE"; - url: Url; + url: "/orgs/:org/public_members/:username"; headers: RequestHeaders; request: RequestRequestOptions; }; + type ReposListForOrgEndpoint = { /** * org parameter */ org: string; /** - * Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`. + * Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`. */ - type?: "all" | "public" | "private" | "forks" | "sources" | "member"; + type?: + | "all" + | "public" + | "private" + | "forks" + | "sources" + | "member" + | "internal"; /** * Can be one of `created`, `updated`, `pushed`, `full_name`. */ @@ -4229,12 +11613,127 @@ type ReposListForOrgEndpoint = { */ page?: number; }; + type ReposListForOrgRequestOptions = { method: "GET"; - url: Url; + url: "/orgs/:org/repos"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposListForOrgResponseDataItemLicense = { + key: string; + name: string; + spdx_id: string; + url: string; + node_id: string; +}; +type ReposListForOrgResponseDataItemPermissions = { + admin: boolean; + push: boolean; + pull: boolean; +}; +type ReposListForOrgResponseDataItemOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposListForOrgResponseDataItem = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: ReposListForOrgResponseDataItemOwner; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: null; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: Array; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: ReposListForOrgResponseDataItemPermissions; + template_repository: null; + temp_clone_token: string; + subscribers_count: number; + network_count: number; + license: ReposListForOrgResponseDataItemLicense; +}; +type ReposListForOrgResponseData = Array; + type ReposCreateInOrgEndpoint = { /** * org parameter @@ -4253,9 +11752,14 @@ type ReposCreateInOrgEndpoint = { */ homepage?: string; /** - * Either `true` to create a private repository or `false` to create a public one. Creating private repositories requires a paid GitHub account. + * Either `true` to create a private repository or `false` to create a public one. */ private?: boolean; + /** + * Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. For more information, see "[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)" in the GitHub Help documentation. + * The `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header. + */ + visibility?: "public" | "private" | "visibility" | "internal"; /** * Either `true` to enable issues for this repository or `false` to disable them. */ @@ -4300,13 +11804,126 @@ type ReposCreateInOrgEndpoint = { * Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging. */ allow_rebase_merge?: boolean; + /** + * Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion. + */ + delete_branch_on_merge?: boolean; }; + type ReposCreateInOrgRequestOptions = { method: "POST"; - url: Url; + url: "/orgs/:org/repos"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposCreateInOrgResponseDataPermissions = { + admin: boolean; + push: boolean; + pull: boolean; +}; +type ReposCreateInOrgResponseDataOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposCreateInOrgResponseData = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: ReposCreateInOrgResponseDataOwner; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: null; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: Array; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: ReposCreateInOrgResponseDataPermissions; + allow_rebase_merge: boolean; + template_repository: null; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; +}; + type TeamsListIdPGroupsForOrgEndpoint = { /** * org parameter @@ -4321,12 +11938,22 @@ type TeamsListIdPGroupsForOrgEndpoint = { */ page?: number; }; + type TeamsListIdPGroupsForOrgRequestOptions = { method: "GET"; - url: Url; + url: "/orgs/:org/team-sync/groups"; headers: RequestHeaders; request: RequestRequestOptions; }; +type TeamsListIdPGroupsForOrgResponseDataGroupsItem = { + group_id: string; + group_name: string; + group_description: string; +}; +type TeamsListIdPGroupsForOrgResponseData = { + groups: Array; +}; + type TeamsListEndpoint = { /** * org parameter @@ -4341,12 +11968,29 @@ type TeamsListEndpoint = { */ page?: number; }; + type TeamsListRequestOptions = { method: "GET"; - url: Url; + url: "/orgs/:org/teams"; headers: RequestHeaders; request: RequestRequestOptions; }; +type TeamsListResponseDataItem = { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: null; +}; +type TeamsListResponseData = Array; + type TeamsCreateEndpoint = { /** * org parameter @@ -4361,7 +12005,7 @@ type TeamsCreateEndpoint = { */ description?: string; /** - * The logins of organization members to add as maintainers of the team. + * List GitHub IDs for organization members who will become team maintainers. */ maintainers?: string[]; /** @@ -4377,7 +12021,6 @@ type TeamsCreateEndpoint = { * **For a parent or child team:** * \* `closed` - visible to all members of this organization. * Default for child team: `closed` - * **Note**: You must pass the `hellcat-preview` media type to set privacy default to `closed` for child teams. */ privacy?: "secret" | "closed"; /** @@ -4388,16 +12031,66 @@ type TeamsCreateEndpoint = { */ permission?: "pull" | "push" | "admin"; /** - * The ID of a team to set as the parent team. **Note**: You must pass the `hellcat-preview` media type to use this parameter. + * The ID of a team to set as the parent team. */ parent_team_id?: number; }; + type TeamsCreateRequestOptions = { method: "POST"; - url: Url; + url: "/orgs/:org/teams"; headers: RequestHeaders; request: RequestRequestOptions; }; +type TeamsCreateResponseDataOrganization = { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; + name: string; + company: string; + blog: string; + location: string; + email: string; + is_verified: boolean; + has_organization_projects: boolean; + has_repository_projects: boolean; + public_repos: number; + public_gists: number; + followers: number; + following: number; + html_url: string; + created_at: string; + type: string; +}; +type TeamsCreateResponseData = { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: null; + members_count: number; + repos_count: number; + created_at: string; + updated_at: string; + organization: TeamsCreateResponseDataOrganization; +}; + type TeamsGetByNameEndpoint = { /** * org parameter @@ -4408,24 +12101,2191 @@ type TeamsGetByNameEndpoint = { */ team_slug: string; }; + type TeamsGetByNameRequestOptions = { method: "GET"; - url: Url; + url: "/orgs/:org/teams/:team_slug"; headers: RequestHeaders; request: RequestRequestOptions; }; +type TeamsGetByNameResponseDataOrganization = { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; + name: string; + company: string; + blog: string; + location: string; + email: string; + is_verified: boolean; + has_organization_projects: boolean; + has_repository_projects: boolean; + public_repos: number; + public_gists: number; + followers: number; + following: number; + html_url: string; + created_at: string; + type: string; +}; +type TeamsGetByNameResponseData = { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: null; + members_count: number; + repos_count: number; + created_at: string; + updated_at: string; + organization: TeamsGetByNameResponseDataOrganization; +}; + +type TeamsUpdateInOrgEndpoint = { + /** + * org parameter + */ + org: string; + /** + * team_slug parameter + */ + team_slug: string; + /** + * The name of the team. + */ + name: string; + /** + * The description of the team. + */ + description?: string; + /** + * The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. When a team is nested, the `privacy` for parent teams cannot be `secret`. The options are: + * **For a non-nested team:** + * \* `secret` - only visible to organization owners and members of this team. + * \* `closed` - visible to all members of this organization. + * **For a parent or child team:** + * \* `closed` - visible to all members of this organization. + */ + privacy?: "secret" | "closed"; + /** + * **Deprecated**. The permission that new repositories will be added to the team with when none is specified. Can be one of: + * \* `pull` - team members can pull, but not push to or administer newly-added repositories. + * \* `push` - team members can pull and push, but not administer newly-added repositories. + * \* `admin` - team members can pull, push and administer newly-added repositories. + */ + permission?: "pull" | "push" | "admin"; + /** + * The ID of a team to set as the parent team. + */ + parent_team_id?: number; +}; + +type TeamsUpdateInOrgRequestOptions = { + method: "PATCH"; + url: "/orgs/:org/teams/:team_slug"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsUpdateInOrgResponseDataOrganization = { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; + name: string; + company: string; + blog: string; + location: string; + email: string; + is_verified: boolean; + has_organization_projects: boolean; + has_repository_projects: boolean; + public_repos: number; + public_gists: number; + followers: number; + following: number; + html_url: string; + created_at: string; + type: string; +}; +type TeamsUpdateInOrgResponseData = { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: null; + members_count: number; + repos_count: number; + created_at: string; + updated_at: string; + organization: TeamsUpdateInOrgResponseDataOrganization; +}; + +type TeamsDeleteInOrgEndpoint = { + /** + * org parameter + */ + org: string; + /** + * team_slug parameter + */ + team_slug: string; +}; + +type TeamsDeleteInOrgRequestOptions = { + method: "DELETE"; + url: "/orgs/:org/teams/:team_slug"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; + +type TeamsListDiscussionsInOrgEndpoint = { + /** + * org parameter + */ + org: string; + /** + * team_slug parameter + */ + team_slug: string; + /** + * Sorts the discussion comments by the date they were created. To return the oldest comments first, set to `asc`. Can be one of `asc` or `desc`. + */ + direction?: "asc" | "desc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; + +type TeamsListDiscussionsInOrgRequestOptions = { + method: "GET"; + url: "/orgs/:org/teams/:team_slug/discussions"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsListDiscussionsInOrgResponseDataItemReactions = { + url: string; + total_count: number; + "+1": number; + "-1": number; + laugh: number; + confused: number; + heart: number; + hooray: number; +}; +type TeamsListDiscussionsInOrgResponseDataItemAuthor = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type TeamsListDiscussionsInOrgResponseDataItem = { + author: TeamsListDiscussionsInOrgResponseDataItemAuthor; + body: string; + body_html: string; + body_version: string; + comments_count: number; + comments_url: string; + created_at: string; + last_edited_at: null; + html_url: string; + node_id: string; + number: number; + pinned: boolean; + private: boolean; + team_url: string; + title: string; + updated_at: string; + url: string; + reactions: TeamsListDiscussionsInOrgResponseDataItemReactions; +}; +type TeamsListDiscussionsInOrgResponseData = Array< + TeamsListDiscussionsInOrgResponseDataItem +>; + +type TeamsCreateDiscussionInOrgEndpoint = { + /** + * org parameter + */ + org: string; + /** + * team_slug parameter + */ + team_slug: string; + /** + * The discussion post's title. + */ + title: string; + /** + * The discussion post's body text. + */ + body: string; + /** + * Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post. + */ + private?: boolean; +}; + +type TeamsCreateDiscussionInOrgRequestOptions = { + method: "POST"; + url: "/orgs/:org/teams/:team_slug/discussions"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsCreateDiscussionInOrgResponseDataReactions = { + url: string; + total_count: number; + "+1": number; + "-1": number; + laugh: number; + confused: number; + heart: number; + hooray: number; +}; +type TeamsCreateDiscussionInOrgResponseDataAuthor = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type TeamsCreateDiscussionInOrgResponseData = { + author: TeamsCreateDiscussionInOrgResponseDataAuthor; + body: string; + body_html: string; + body_version: string; + comments_count: number; + comments_url: string; + created_at: string; + last_edited_at: null; + html_url: string; + node_id: string; + number: number; + pinned: boolean; + private: boolean; + team_url: string; + title: string; + updated_at: string; + url: string; + reactions: TeamsCreateDiscussionInOrgResponseDataReactions; +}; + +type TeamsGetDiscussionInOrgEndpoint = { + /** + * org parameter + */ + org: string; + /** + * team_slug parameter + */ + team_slug: string; + /** + * discussion_number parameter + */ + discussion_number: number; +}; + +type TeamsGetDiscussionInOrgRequestOptions = { + method: "GET"; + url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsGetDiscussionInOrgResponseDataReactions = { + url: string; + total_count: number; + "+1": number; + "-1": number; + laugh: number; + confused: number; + heart: number; + hooray: number; +}; +type TeamsGetDiscussionInOrgResponseDataAuthor = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type TeamsGetDiscussionInOrgResponseData = { + author: TeamsGetDiscussionInOrgResponseDataAuthor; + body: string; + body_html: string; + body_version: string; + comments_count: number; + comments_url: string; + created_at: string; + last_edited_at: null; + html_url: string; + node_id: string; + number: number; + pinned: boolean; + private: boolean; + team_url: string; + title: string; + updated_at: string; + url: string; + reactions: TeamsGetDiscussionInOrgResponseDataReactions; +}; + +type TeamsUpdateDiscussionInOrgEndpoint = { + /** + * org parameter + */ + org: string; + /** + * team_slug parameter + */ + team_slug: string; + /** + * discussion_number parameter + */ + discussion_number: number; + /** + * The discussion post's title. + */ + title?: string; + /** + * The discussion post's body text. + */ + body?: string; +}; + +type TeamsUpdateDiscussionInOrgRequestOptions = { + method: "PATCH"; + url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsUpdateDiscussionInOrgResponseDataReactions = { + url: string; + total_count: number; + "+1": number; + "-1": number; + laugh: number; + confused: number; + heart: number; + hooray: number; +}; +type TeamsUpdateDiscussionInOrgResponseDataAuthor = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type TeamsUpdateDiscussionInOrgResponseData = { + author: TeamsUpdateDiscussionInOrgResponseDataAuthor; + body: string; + body_html: string; + body_version: string; + comments_count: number; + comments_url: string; + created_at: string; + last_edited_at: string; + html_url: string; + node_id: string; + number: number; + pinned: boolean; + private: boolean; + team_url: string; + title: string; + updated_at: string; + url: string; + reactions: TeamsUpdateDiscussionInOrgResponseDataReactions; +}; + +type TeamsDeleteDiscussionInOrgEndpoint = { + /** + * org parameter + */ + org: string; + /** + * team_slug parameter + */ + team_slug: string; + /** + * discussion_number parameter + */ + discussion_number: number; +}; + +type TeamsDeleteDiscussionInOrgRequestOptions = { + method: "DELETE"; + url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; + +type TeamsListDiscussionCommentsInOrgEndpoint = { + /** + * org parameter + */ + org: string; + /** + * team_slug parameter + */ + team_slug: string; + /** + * discussion_number parameter + */ + discussion_number: number; + /** + * Sorts the discussion comments by the date they were created. To return the oldest comments first, set to `asc`. Can be one of `asc` or `desc`. + */ + direction?: "asc" | "desc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; + +type TeamsListDiscussionCommentsInOrgRequestOptions = { + method: "GET"; + url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/comments"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsListDiscussionCommentsInOrgResponseDataItemReactions = { + url: string; + total_count: number; + "+1": number; + "-1": number; + laugh: number; + confused: number; + heart: number; + hooray: number; +}; +type TeamsListDiscussionCommentsInOrgResponseDataItemAuthor = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type TeamsListDiscussionCommentsInOrgResponseDataItem = { + author: TeamsListDiscussionCommentsInOrgResponseDataItemAuthor; + body: string; + body_html: string; + body_version: string; + created_at: string; + last_edited_at: null; + discussion_url: string; + html_url: string; + node_id: string; + number: number; + updated_at: string; + url: string; + reactions: TeamsListDiscussionCommentsInOrgResponseDataItemReactions; +}; +type TeamsListDiscussionCommentsInOrgResponseData = Array< + TeamsListDiscussionCommentsInOrgResponseDataItem +>; + +type TeamsCreateDiscussionCommentInOrgEndpoint = { + /** + * org parameter + */ + org: string; + /** + * team_slug parameter + */ + team_slug: string; + /** + * discussion_number parameter + */ + discussion_number: number; + /** + * The discussion comment's body text. + */ + body: string; +}; + +type TeamsCreateDiscussionCommentInOrgRequestOptions = { + method: "POST"; + url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/comments"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsCreateDiscussionCommentInOrgResponseDataReactions = { + url: string; + total_count: number; + "+1": number; + "-1": number; + laugh: number; + confused: number; + heart: number; + hooray: number; +}; +type TeamsCreateDiscussionCommentInOrgResponseDataAuthor = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type TeamsCreateDiscussionCommentInOrgResponseData = { + author: TeamsCreateDiscussionCommentInOrgResponseDataAuthor; + body: string; + body_html: string; + body_version: string; + created_at: string; + last_edited_at: null; + discussion_url: string; + html_url: string; + node_id: string; + number: number; + updated_at: string; + url: string; + reactions: TeamsCreateDiscussionCommentInOrgResponseDataReactions; +}; + +type TeamsGetDiscussionCommentInOrgEndpoint = { + /** + * org parameter + */ + org: string; + /** + * team_slug parameter + */ + team_slug: string; + /** + * discussion_number parameter + */ + discussion_number: number; + /** + * comment_number parameter + */ + comment_number: number; +}; + +type TeamsGetDiscussionCommentInOrgRequestOptions = { + method: "GET"; + url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsGetDiscussionCommentInOrgResponseDataReactions = { + url: string; + total_count: number; + "+1": number; + "-1": number; + laugh: number; + confused: number; + heart: number; + hooray: number; +}; +type TeamsGetDiscussionCommentInOrgResponseDataAuthor = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type TeamsGetDiscussionCommentInOrgResponseData = { + author: TeamsGetDiscussionCommentInOrgResponseDataAuthor; + body: string; + body_html: string; + body_version: string; + created_at: string; + last_edited_at: null; + discussion_url: string; + html_url: string; + node_id: string; + number: number; + updated_at: string; + url: string; + reactions: TeamsGetDiscussionCommentInOrgResponseDataReactions; +}; + +type TeamsUpdateDiscussionCommentInOrgEndpoint = { + /** + * org parameter + */ + org: string; + /** + * team_slug parameter + */ + team_slug: string; + /** + * discussion_number parameter + */ + discussion_number: number; + /** + * comment_number parameter + */ + comment_number: number; + /** + * The discussion comment's body text. + */ + body: string; +}; + +type TeamsUpdateDiscussionCommentInOrgRequestOptions = { + method: "PATCH"; + url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsUpdateDiscussionCommentInOrgResponseDataReactions = { + url: string; + total_count: number; + "+1": number; + "-1": number; + laugh: number; + confused: number; + heart: number; + hooray: number; +}; +type TeamsUpdateDiscussionCommentInOrgResponseDataAuthor = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type TeamsUpdateDiscussionCommentInOrgResponseData = { + author: TeamsUpdateDiscussionCommentInOrgResponseDataAuthor; + body: string; + body_html: string; + body_version: string; + created_at: string; + last_edited_at: string; + discussion_url: string; + html_url: string; + node_id: string; + number: number; + updated_at: string; + url: string; + reactions: TeamsUpdateDiscussionCommentInOrgResponseDataReactions; +}; + +type TeamsDeleteDiscussionCommentInOrgEndpoint = { + /** + * org parameter + */ + org: string; + /** + * team_slug parameter + */ + team_slug: string; + /** + * discussion_number parameter + */ + discussion_number: number; + /** + * comment_number parameter + */ + comment_number: number; +}; + +type TeamsDeleteDiscussionCommentInOrgRequestOptions = { + method: "DELETE"; + url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; + +type ReactionsListForTeamDiscussionCommentInOrgEndpoint = { + /** + * org parameter + */ + org: string; + /** + * team_slug parameter + */ + team_slug: string; + /** + * discussion_number parameter + */ + discussion_number: number; + /** + * comment_number parameter + */ + comment_number: number; + /** + * Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a team discussion comment. + */ + content?: + | "+1" + | "-1" + | "laugh" + | "confused" + | "heart" + | "hooray" + | "rocket" + | "eyes"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +} & RequiredPreview<"squirrel-girl">; + +type ReactionsListForTeamDiscussionCommentInOrgRequestOptions = { + method: "GET"; + url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number/reactions"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReactionsListForTeamDiscussionCommentInOrgResponseDataItemUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReactionsListForTeamDiscussionCommentInOrgResponseDataItem = { + id: number; + node_id: string; + user: ReactionsListForTeamDiscussionCommentInOrgResponseDataItemUser; + content: string; + created_at: string; +}; +type ReactionsListForTeamDiscussionCommentInOrgResponseData = Array< + ReactionsListForTeamDiscussionCommentInOrgResponseDataItem +>; + +type ReactionsCreateForTeamDiscussionCommentInOrgEndpoint = { + /** + * org parameter + */ + org: string; + /** + * team_slug parameter + */ + team_slug: string; + /** + * discussion_number parameter + */ + discussion_number: number; + /** + * comment_number parameter + */ + comment_number: number; + /** + * The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the team discussion comment. + */ + content: + | "+1" + | "-1" + | "laugh" + | "confused" + | "heart" + | "hooray" + | "rocket" + | "eyes"; +} & RequiredPreview<"squirrel-girl">; + +type ReactionsCreateForTeamDiscussionCommentInOrgRequestOptions = { + method: "POST"; + url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number/reactions"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReactionsCreateForTeamDiscussionCommentInOrgResponseDataUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReactionsCreateForTeamDiscussionCommentInOrgResponseData = { + id: number; + node_id: string; + user: ReactionsCreateForTeamDiscussionCommentInOrgResponseDataUser; + content: string; + created_at: string; +}; + +type ReactionsDeleteForTeamDiscussionCommentEndpoint = { + /** + * org parameter + */ + org: string; + /** + * team_slug parameter + */ + team_slug: string; + /** + * discussion_number parameter + */ + discussion_number: number; + /** + * comment_number parameter + */ + comment_number: number; + /** + * reaction_id parameter + */ + reaction_id: number; +} & RequiredPreview<"squirrel-girl">; + +type ReactionsDeleteForTeamDiscussionCommentRequestOptions = { + method: "DELETE"; + url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; + +type ReactionsListForTeamDiscussionInOrgEndpoint = { + /** + * org parameter + */ + org: string; + /** + * team_slug parameter + */ + team_slug: string; + /** + * discussion_number parameter + */ + discussion_number: number; + /** + * Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a team discussion. + */ + content?: + | "+1" + | "-1" + | "laugh" + | "confused" + | "heart" + | "hooray" + | "rocket" + | "eyes"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +} & RequiredPreview<"squirrel-girl">; + +type ReactionsListForTeamDiscussionInOrgRequestOptions = { + method: "GET"; + url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/reactions"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReactionsListForTeamDiscussionInOrgResponseDataItemUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReactionsListForTeamDiscussionInOrgResponseDataItem = { + id: number; + node_id: string; + user: ReactionsListForTeamDiscussionInOrgResponseDataItemUser; + content: string; + created_at: string; +}; +type ReactionsListForTeamDiscussionInOrgResponseData = Array< + ReactionsListForTeamDiscussionInOrgResponseDataItem +>; + +type ReactionsCreateForTeamDiscussionInOrgEndpoint = { + /** + * org parameter + */ + org: string; + /** + * team_slug parameter + */ + team_slug: string; + /** + * discussion_number parameter + */ + discussion_number: number; + /** + * The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the team discussion. + */ + content: + | "+1" + | "-1" + | "laugh" + | "confused" + | "heart" + | "hooray" + | "rocket" + | "eyes"; +} & RequiredPreview<"squirrel-girl">; + +type ReactionsCreateForTeamDiscussionInOrgRequestOptions = { + method: "POST"; + url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/reactions"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReactionsCreateForTeamDiscussionInOrgResponseDataUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReactionsCreateForTeamDiscussionInOrgResponseData = { + id: number; + node_id: string; + user: ReactionsCreateForTeamDiscussionInOrgResponseDataUser; + content: string; + created_at: string; +}; + +type ReactionsDeleteForTeamDiscussionEndpoint = { + /** + * org parameter + */ + org: string; + /** + * team_slug parameter + */ + team_slug: string; + /** + * discussion_number parameter + */ + discussion_number: number; + /** + * reaction_id parameter + */ + reaction_id: number; +} & RequiredPreview<"squirrel-girl">; + +type ReactionsDeleteForTeamDiscussionRequestOptions = { + method: "DELETE"; + url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/reactions/:reaction_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; + +type TeamsListPendingInvitationsInOrgEndpoint = { + /** + * org parameter + */ + org: string; + /** + * team_slug parameter + */ + team_slug: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; + +type TeamsListPendingInvitationsInOrgRequestOptions = { + method: "GET"; + url: "/orgs/:org/teams/:team_slug/invitations"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsListPendingInvitationsInOrgResponseDataItemInviter = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type TeamsListPendingInvitationsInOrgResponseDataItem = { + id: number; + login: string; + email: string; + role: string; + created_at: string; + inviter: TeamsListPendingInvitationsInOrgResponseDataItemInviter; + team_count: number; + invitation_team_url: string; +}; +type TeamsListPendingInvitationsInOrgResponseData = Array< + TeamsListPendingInvitationsInOrgResponseDataItem +>; + +type TeamsListMembersInOrgEndpoint = { + /** + * org parameter + */ + org: string; + /** + * team_slug parameter + */ + team_slug: string; + /** + * Filters members returned by their role in the team. Can be one of: + * \* `member` - normal members of the team. + * \* `maintainer` - team maintainers. + * \* `all` - all members of the team. + */ + role?: "member" | "maintainer" | "all"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; + +type TeamsListMembersInOrgRequestOptions = { + method: "GET"; + url: "/orgs/:org/teams/:team_slug/members"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsListMembersInOrgResponseDataItem = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type TeamsListMembersInOrgResponseData = Array< + TeamsListMembersInOrgResponseDataItem +>; + +type TeamsGetMembershipInOrgEndpoint = { + /** + * org parameter + */ + org: string; + /** + * team_slug parameter + */ + team_slug: string; + /** + * username parameter + */ + username: string; +}; + +type TeamsGetMembershipInOrgRequestOptions = { + method: "GET"; + url: "/orgs/:org/teams/:team_slug/memberships/:username"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsGetMembershipInOrgResponseData = { + url: string; + role: string; + state: string; +}; + +type TeamsAddOrUpdateMembershipInOrgEndpoint = { + /** + * org parameter + */ + org: string; + /** + * team_slug parameter + */ + team_slug: string; + /** + * username parameter + */ + username: string; + /** + * The role that this user should have in the team. Can be one of: + * \* `member` - a normal member of the team. + * \* `maintainer` - a team maintainer. Able to add/remove other team members, promote other team members to team maintainer, and edit the team's name and description. + */ + role?: "member" | "maintainer"; +}; + +type TeamsAddOrUpdateMembershipInOrgRequestOptions = { + method: "PUT"; + url: "/orgs/:org/teams/:team_slug/memberships/:username"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsAddOrUpdateMembershipInOrgResponseData = { + url: string; + role: string; + state: string; +}; + +type TeamsRemoveMembershipInOrgEndpoint = { + /** + * org parameter + */ + org: string; + /** + * team_slug parameter + */ + team_slug: string; + /** + * username parameter + */ + username: string; +}; + +type TeamsRemoveMembershipInOrgRequestOptions = { + method: "DELETE"; + url: "/orgs/:org/teams/:team_slug/memberships/:username"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; + +type TeamsListProjectsInOrgEndpoint = { + /** + * org parameter + */ + org: string; + /** + * team_slug parameter + */ + team_slug: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +} & RequiredPreview<"inertia">; + +type TeamsListProjectsInOrgRequestOptions = { + method: "GET"; + url: "/orgs/:org/teams/:team_slug/projects"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsListProjectsInOrgResponseDataItemPermissions = { + read: boolean; + write: boolean; + admin: boolean; +}; +type TeamsListProjectsInOrgResponseDataItemCreator = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type TeamsListProjectsInOrgResponseDataItem = { + owner_url: string; + url: string; + html_url: string; + columns_url: string; + id: number; + node_id: string; + name: string; + body: string; + number: number; + state: string; + creator: TeamsListProjectsInOrgResponseDataItemCreator; + created_at: string; + updated_at: string; + organization_permission: string; + private: boolean; + permissions: TeamsListProjectsInOrgResponseDataItemPermissions; +}; +type TeamsListProjectsInOrgResponseData = Array< + TeamsListProjectsInOrgResponseDataItem +>; + +type TeamsReviewProjectInOrgEndpoint = { + /** + * org parameter + */ + org: string; + /** + * team_slug parameter + */ + team_slug: string; + /** + * project_id parameter + */ + project_id: number; +} & RequiredPreview<"inertia">; + +type TeamsReviewProjectInOrgRequestOptions = { + method: "GET"; + url: "/orgs/:org/teams/:team_slug/projects/:project_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsReviewProjectInOrgResponseDataPermissions = { + read: boolean; + write: boolean; + admin: boolean; +}; +type TeamsReviewProjectInOrgResponseDataCreator = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type TeamsReviewProjectInOrgResponseData = { + owner_url: string; + url: string; + html_url: string; + columns_url: string; + id: number; + node_id: string; + name: string; + body: string; + number: number; + state: string; + creator: TeamsReviewProjectInOrgResponseDataCreator; + created_at: string; + updated_at: string; + organization_permission: string; + private: boolean; + permissions: TeamsReviewProjectInOrgResponseDataPermissions; +}; + +type TeamsAddOrUpdateProjectInOrgEndpoint = { + /** + * org parameter + */ + org: string; + /** + * team_slug parameter + */ + team_slug: string; + /** + * project_id parameter + */ + project_id: number; + /** + * The permission to grant to the team for this project. Can be one of: + * \* `read` - team members can read, but not write to or administer this project. + * \* `write` - team members can read and write, but not administer this project. + * \* `admin` - team members can read, write and administer this project. + * Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://developer.github.com/v3/#http-verbs)." + */ + permission?: "read" | "write" | "admin"; +} & RequiredPreview<"inertia">; + +type TeamsAddOrUpdateProjectInOrgRequestOptions = { + method: "PUT"; + url: "/orgs/:org/teams/:team_slug/projects/:project_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsAddOrUpdateProjectInOrgResponseData = { + message: string; + documentation_url: string; +}; + +type TeamsRemoveProjectInOrgEndpoint = { + /** + * org parameter + */ + org: string; + /** + * team_slug parameter + */ + team_slug: string; + /** + * project_id parameter + */ + project_id: number; +}; + +type TeamsRemoveProjectInOrgRequestOptions = { + method: "DELETE"; + url: "/orgs/:org/teams/:team_slug/projects/:project_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; + +type TeamsListReposInOrgEndpoint = { + /** + * org parameter + */ + org: string; + /** + * team_slug parameter + */ + team_slug: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; + +type TeamsListReposInOrgRequestOptions = { + method: "GET"; + url: "/orgs/:org/teams/:team_slug/repos"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsListReposInOrgResponseDataItemLicense = { + key: string; + name: string; + spdx_id: string; + url: string; + node_id: string; +}; +type TeamsListReposInOrgResponseDataItemPermissions = { + admin: boolean; + push: boolean; + pull: boolean; +}; +type TeamsListReposInOrgResponseDataItemOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type TeamsListReposInOrgResponseDataItem = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: TeamsListReposInOrgResponseDataItemOwner; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: null; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: Array; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: TeamsListReposInOrgResponseDataItemPermissions; + template_repository: null; + temp_clone_token: string; + subscribers_count: number; + network_count: number; + license: TeamsListReposInOrgResponseDataItemLicense; +}; +type TeamsListReposInOrgResponseData = Array< + TeamsListReposInOrgResponseDataItem +>; + +type TeamsCheckManagesRepoInOrgEndpoint = { + /** + * org parameter + */ + org: string; + /** + * team_slug parameter + */ + team_slug: string; + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; + +type TeamsCheckManagesRepoInOrgRequestOptions = { + method: "GET"; + url: "/orgs/:org/teams/:team_slug/repos/:owner/:repo"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsCheckManagesRepoInOrgResponseDataPermissions = { + pull: boolean; + triage: boolean; + push: boolean; + maintain: boolean; + admin: boolean; +}; +type TeamsCheckManagesRepoInOrgResponseDataSourcePermissions = { + admin: boolean; + push: boolean; + pull: boolean; +}; +type TeamsCheckManagesRepoInOrgResponseDataSourceOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type TeamsCheckManagesRepoInOrgResponseDataSource = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: TeamsCheckManagesRepoInOrgResponseDataSourceOwner; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: null; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: Array; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: TeamsCheckManagesRepoInOrgResponseDataSourcePermissions; + allow_rebase_merge: boolean; + template_repository: null; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; +}; +type TeamsCheckManagesRepoInOrgResponseDataParentPermissions = { + admin: boolean; + push: boolean; + pull: boolean; +}; +type TeamsCheckManagesRepoInOrgResponseDataParentOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type TeamsCheckManagesRepoInOrgResponseDataParent = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: TeamsCheckManagesRepoInOrgResponseDataParentOwner; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: null; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: Array; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: TeamsCheckManagesRepoInOrgResponseDataParentPermissions; + allow_rebase_merge: boolean; + template_repository: null; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; +}; +type TeamsCheckManagesRepoInOrgResponseDataOrganization = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type TeamsCheckManagesRepoInOrgResponseData = { + organization: TeamsCheckManagesRepoInOrgResponseDataOrganization; + parent: TeamsCheckManagesRepoInOrgResponseDataParent; + source: TeamsCheckManagesRepoInOrgResponseDataSource; + permissions: TeamsCheckManagesRepoInOrgResponseDataPermissions; +}; + +type TeamsAddOrUpdateRepoInOrgEndpoint = { + /** + * org parameter + */ + org: string; + /** + * team_slug parameter + */ + team_slug: string; + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * The permission to grant the team on this repository. Can be one of: + * \* `pull` - team members can pull, but not push to or administer this repository. + * \* `push` - team members can pull and push, but not administer this repository. + * \* `admin` - team members can pull, push and administer this repository. + * \* `maintain` - team members can manage the repository without access to sensitive or destructive actions. Recommended for project managers. Only applies to repositories owned by organizations. + * \* `triage` - team members can proactively manage issues and pull requests without write access. Recommended for contributors who triage a repository. Only applies to repositories owned by organizations. + * + * If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository. + */ + permission?: "pull" | "push" | "admin" | "maintain" | "triage"; +}; + +type TeamsAddOrUpdateRepoInOrgRequestOptions = { + method: "PUT"; + url: "/orgs/:org/teams/:team_slug/repos/:owner/:repo"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; + +type TeamsRemoveRepoInOrgEndpoint = { + /** + * org parameter + */ + org: string; + /** + * team_slug parameter + */ + team_slug: string; + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; + +type TeamsRemoveRepoInOrgRequestOptions = { + method: "DELETE"; + url: "/orgs/:org/teams/:team_slug/repos/:owner/:repo"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; + +type TeamsListIdPGroupsInOrgEndpoint = { + /** + * org parameter + */ + org: string; + /** + * team_slug parameter + */ + team_slug: string; +}; + +type TeamsListIdPGroupsInOrgRequestOptions = { + method: "GET"; + url: "/orgs/:org/teams/:team_slug/team-sync/group-mappings"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsListIdPGroupsInOrgResponseDataGroupsItem = { + group_id: string; + group_name: string; + group_description: string; +}; +type TeamsListIdPGroupsInOrgResponseData = { + groups: Array; +}; + +type TeamsCreateOrUpdateIdPGroupConnectionsInOrgEndpoint = { + /** + * org parameter + */ + org: string; + /** + * team_slug parameter + */ + team_slug: string; + /** + * The IdP groups you want to connect to a GitHub team. When updating, the new `groups` object will replace the original one. You must include any existing groups that you don't want to remove. + */ + groups: TeamsCreateOrUpdateIdPGroupConnectionsInOrgParamsGroups[]; +}; + +type TeamsCreateOrUpdateIdPGroupConnectionsInOrgRequestOptions = { + method: "PATCH"; + url: "/orgs/:org/teams/:team_slug/team-sync/group-mappings"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsCreateOrUpdateIdPGroupConnectionsInOrgResponseDataGroups = { + group_id: string; + group_name: string; + group_description: string; +}; +type TeamsCreateOrUpdateIdPGroupConnectionsInOrgResponseData = { + groups: TeamsCreateOrUpdateIdPGroupConnectionsInOrgResponseDataGroups; +}; + +type TeamsListChildInOrgEndpoint = { + /** + * org parameter + */ + org: string; + /** + * team_slug parameter + */ + team_slug: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; + +type TeamsListChildInOrgRequestOptions = { + method: "GET"; + url: "/orgs/:org/teams/:team_slug/teams"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsListChildInOrgResponseDataItemParent = { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; +}; +type TeamsListChildInOrgResponseDataItem = { + id: number; + node_id: string; + url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: TeamsListChildInOrgResponseDataItemParent; +}; +type TeamsListChildInOrgResponseData = Array< + TeamsListChildInOrgResponseDataItem +>; + type ProjectsGetCardEndpoint = { /** * card_id parameter */ card_id: number; -}; +} & RequiredPreview<"inertia">; + type ProjectsGetCardRequestOptions = { method: "GET"; - url: Url; + url: "/projects/columns/cards/:card_id"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ProjectsGetCardResponseDataCreator = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ProjectsGetCardResponseData = { + url: string; + id: number; + node_id: string; + note: string; + creator: ProjectsGetCardResponseDataCreator; + created_at: string; + updated_at: string; + archived: boolean; + column_url: string; + content_url: string; + project_url: string; +}; + type ProjectsUpdateCardEndpoint = { /** * card_id parameter @@ -4439,25 +14299,62 @@ type ProjectsUpdateCardEndpoint = { * Use `true` to archive a project card. Specify `false` if you need to restore a previously archived project card. */ archived?: boolean; -}; +} & RequiredPreview<"inertia">; + type ProjectsUpdateCardRequestOptions = { method: "PATCH"; - url: Url; + url: "/projects/columns/cards/:card_id"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ProjectsUpdateCardResponseDataCreator = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ProjectsUpdateCardResponseData = { + url: string; + id: number; + node_id: string; + note: string; + creator: ProjectsUpdateCardResponseDataCreator; + created_at: string; + updated_at: string; + archived: boolean; + column_url: string; + content_url: string; + project_url: string; +}; + type ProjectsDeleteCardEndpoint = { /** * card_id parameter */ card_id: number; -}; +} & RequiredPreview<"inertia">; + type ProjectsDeleteCardRequestOptions = { method: "DELETE"; - url: Url; + url: "/projects/columns/cards/:card_id"; headers: RequestHeaders; request: RequestRequestOptions; }; + type ProjectsMoveCardEndpoint = { /** * card_id parameter @@ -4471,25 +14368,39 @@ type ProjectsMoveCardEndpoint = { * The `id` value of a column in the same project. */ column_id?: number; -}; +} & RequiredPreview<"inertia">; + type ProjectsMoveCardRequestOptions = { method: "POST"; - url: Url; + url: "/projects/columns/cards/:card_id/moves"; headers: RequestHeaders; request: RequestRequestOptions; }; + type ProjectsGetColumnEndpoint = { /** * column_id parameter */ column_id: number; -}; +} & RequiredPreview<"inertia">; + type ProjectsGetColumnRequestOptions = { method: "GET"; - url: Url; + url: "/projects/columns/:column_id"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ProjectsGetColumnResponseData = { + url: string; + project_url: string; + cards_url: string; + id: number; + node_id: string; + name: string; + created_at: string; + updated_at: string; +}; + type ProjectsUpdateColumnEndpoint = { /** * column_id parameter @@ -4499,25 +14410,39 @@ type ProjectsUpdateColumnEndpoint = { * The new name of the column. */ name: string; -}; +} & RequiredPreview<"inertia">; + type ProjectsUpdateColumnRequestOptions = { method: "PATCH"; - url: Url; + url: "/projects/columns/:column_id"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ProjectsUpdateColumnResponseData = { + url: string; + project_url: string; + cards_url: string; + id: number; + node_id: string; + name: string; + created_at: string; + updated_at: string; +}; + type ProjectsDeleteColumnEndpoint = { /** * column_id parameter */ column_id: number; -}; +} & RequiredPreview<"inertia">; + type ProjectsDeleteColumnRequestOptions = { method: "DELETE"; - url: Url; + url: "/projects/columns/:column_id"; headers: RequestHeaders; request: RequestRequestOptions; }; + type ProjectsListCardsEndpoint = { /** * column_id parameter @@ -4535,13 +14460,49 @@ type ProjectsListCardsEndpoint = { * Page number of the results to fetch. */ page?: number; -}; +} & RequiredPreview<"inertia">; + type ProjectsListCardsRequestOptions = { method: "GET"; - url: Url; + url: "/projects/columns/:column_id/cards"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ProjectsListCardsResponseDataItemCreator = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ProjectsListCardsResponseDataItem = { + url: string; + id: number; + node_id: string; + note: string; + creator: ProjectsListCardsResponseDataItemCreator; + created_at: string; + updated_at: string; + archived: boolean; + column_url: string; + content_url: string; + project_url: string; +}; +type ProjectsListCardsResponseData = Array; + type ProjectsCreateCardEndpoint = { /** * column_id parameter @@ -4552,7 +14513,7 @@ type ProjectsCreateCardEndpoint = { */ note?: string; /** - * The issue or pull request id you want to associate with this card. You can use the [List issues for a repository](https://developer.github.com/v3/issues/#list-issues-for-a-repository) and [List pull requests](https://developer.github.com/v3/pulls/#list-pull-requests) endpoints to find this id. + * The issue or pull request id you want to associate with this card. You can use the [List repository issues](https://developer.github.com/v3/issues/#list-repository-issues) and [List pull requests](https://developer.github.com/v3/pulls/#list-pull-requests) endpoints to find this id. * **Note:** Depending on whether you use the issue id or pull request id, you will need to specify `Issue` or `PullRequest` as the `content_type`. */ content_id?: number; @@ -4560,13 +14521,48 @@ type ProjectsCreateCardEndpoint = { * **Required if you provide `content_id`**. The type of content you want to associate with this card. Use `Issue` when `content_id` is an issue id and use `PullRequest` when `content_id` is a pull request id. */ content_type?: string; -}; +} & RequiredPreview<"inertia">; + type ProjectsCreateCardRequestOptions = { method: "POST"; - url: Url; + url: "/projects/columns/:column_id/cards"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ProjectsCreateCardResponseDataCreator = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ProjectsCreateCardResponseData = { + url: string; + id: number; + node_id: string; + note: string; + creator: ProjectsCreateCardResponseDataCreator; + created_at: string; + updated_at: string; + archived: boolean; + column_url: string; + content_url: string; + project_url: string; +}; + type ProjectsMoveColumnEndpoint = { /** * column_id parameter @@ -4576,33 +14572,64 @@ type ProjectsMoveColumnEndpoint = { * Can be one of `first`, `last`, or `after:`, where `` is the `id` value of a column in the same project. */ position: string; -}; +} & RequiredPreview<"inertia">; + type ProjectsMoveColumnRequestOptions = { method: "POST"; - url: Url; + url: "/projects/columns/:column_id/moves"; headers: RequestHeaders; request: RequestRequestOptions; }; + type ProjectsGetEndpoint = { /** * project_id parameter */ project_id: number; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; +} & RequiredPreview<"inertia">; + type ProjectsGetRequestOptions = { method: "GET"; - url: Url; + url: "/projects/:project_id"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ProjectsGetResponseDataCreator = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ProjectsGetResponseData = { + owner_url: string; + url: string; + html_url: string; + columns_url: string; + id: number; + node_id: string; + name: string; + body: string; + number: number; + state: string; + creator: ProjectsGetResponseDataCreator; + created_at: string; + updated_at: string; +}; + type ProjectsUpdateEndpoint = { /** * project_id parameter @@ -4640,25 +14667,64 @@ type ProjectsUpdateEndpoint = { * \* `true` - Only the user can view a project board created on a user account. Organization members with the appropriate `organization_permission` can see project boards in an organization account. */ private?: boolean; -}; +} & RequiredPreview<"inertia">; + type ProjectsUpdateRequestOptions = { method: "PATCH"; - url: Url; + url: "/projects/:project_id"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ProjectsUpdateResponseDataCreator = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ProjectsUpdateResponseData = { + owner_url: string; + url: string; + html_url: string; + columns_url: string; + id: number; + node_id: string; + name: string; + body: string; + number: number; + state: string; + creator: ProjectsUpdateResponseDataCreator; + created_at: string; + updated_at: string; +}; + type ProjectsDeleteEndpoint = { /** * project_id parameter */ project_id: number; -}; +} & RequiredPreview<"inertia">; + type ProjectsDeleteRequestOptions = { method: "DELETE"; - url: Url; + url: "/projects/:project_id"; headers: RequestHeaders; request: RequestRequestOptions; }; + type ProjectsListCollaboratorsEndpoint = { /** * project_id parameter @@ -4679,13 +14745,38 @@ type ProjectsListCollaboratorsEndpoint = { * Page number of the results to fetch. */ page?: number; -}; +} & RequiredPreview<"inertia">; + type ProjectsListCollaboratorsRequestOptions = { method: "GET"; - url: Url; + url: "/projects/:project_id/collaborators"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ProjectsListCollaboratorsResponseDataItem = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ProjectsListCollaboratorsResponseData = Array< + ProjectsListCollaboratorsResponseDataItem +>; + type ProjectsAddCollaboratorEndpoint = { /** * project_id parameter @@ -4702,13 +14793,15 @@ type ProjectsAddCollaboratorEndpoint = { * \* `admin` - can read, write and administer this project. */ permission?: "read" | "write" | "admin"; -}; +} & RequiredPreview<"inertia">; + type ProjectsAddCollaboratorRequestOptions = { method: "PUT"; - url: Url; + url: "/projects/:project_id/collaborators/:username"; headers: RequestHeaders; request: RequestRequestOptions; }; + type ProjectsRemoveCollaboratorEndpoint = { /** * project_id parameter @@ -4718,13 +14811,15 @@ type ProjectsRemoveCollaboratorEndpoint = { * username parameter */ username: string; -}; +} & RequiredPreview<"inertia">; + type ProjectsRemoveCollaboratorRequestOptions = { method: "DELETE"; - url: Url; + url: "/projects/:project_id/collaborators/:username"; headers: RequestHeaders; request: RequestRequestOptions; }; + type ProjectsReviewUserPermissionLevelEndpoint = { /** * project_id parameter @@ -4734,13 +14829,39 @@ type ProjectsReviewUserPermissionLevelEndpoint = { * username parameter */ username: string; -}; +} & RequiredPreview<"inertia">; + type ProjectsReviewUserPermissionLevelRequestOptions = { method: "GET"; - url: Url; + url: "/projects/:project_id/collaborators/:username/permission"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ProjectsReviewUserPermissionLevelResponseDataUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ProjectsReviewUserPermissionLevelResponseData = { + permission: string; + user: ProjectsReviewUserPermissionLevelResponseDataUser; +}; + type ProjectsListColumnsEndpoint = { /** * project_id parameter @@ -4754,13 +14875,28 @@ type ProjectsListColumnsEndpoint = { * Page number of the results to fetch. */ page?: number; -}; +} & RequiredPreview<"inertia">; + type ProjectsListColumnsRequestOptions = { method: "GET"; - url: Url; + url: "/projects/:project_id/columns"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ProjectsListColumnsResponseDataItem = { + url: string; + project_url: string; + cards_url: string; + id: number; + node_id: string; + name: string; + created_at: string; + updated_at: string; +}; +type ProjectsListColumnsResponseData = Array< + ProjectsListColumnsResponseDataItem +>; + type ProjectsCreateColumnEndpoint = { /** * project_id parameter @@ -4770,32 +14906,83 @@ type ProjectsCreateColumnEndpoint = { * The name of the column. */ name: string; -}; +} & RequiredPreview<"inertia">; + type ProjectsCreateColumnRequestOptions = { method: "POST"; - url: Url; + url: "/projects/:project_id/columns"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ProjectsCreateColumnResponseData = { + url: string; + project_url: string; + cards_url: string; + id: number; + node_id: string; + name: string; + created_at: string; + updated_at: string; +}; + type RateLimitGetEndpoint = {}; + type RateLimitGetRequestOptions = { method: "GET"; - url: Url; + url: "/rate_limit"; headers: RequestHeaders; request: RequestRequestOptions; }; -type ReactionsDeleteEndpoint = { +type RateLimitGetResponseDataRate = { + limit: number; + remaining: number; + reset: number; +}; +type RateLimitGetResponseDataResourcesIntegrationManifest = { + limit: number; + remaining: number; + reset: number; +}; +type RateLimitGetResponseDataResourcesGraphql = { + limit: number; + remaining: number; + reset: number; +}; +type RateLimitGetResponseDataResourcesSearch = { + limit: number; + remaining: number; + reset: number; +}; +type RateLimitGetResponseDataResourcesCore = { + limit: number; + remaining: number; + reset: number; +}; +type RateLimitGetResponseDataResources = { + core: RateLimitGetResponseDataResourcesCore; + search: RateLimitGetResponseDataResourcesSearch; + graphql: RateLimitGetResponseDataResourcesGraphql; + integration_manifest: RateLimitGetResponseDataResourcesIntegrationManifest; +}; +type RateLimitGetResponseData = { + resources: RateLimitGetResponseDataResources; + rate: RateLimitGetResponseDataRate; +}; + +type ReactionsDeleteLegacyEndpoint = { /** * reaction_id parameter */ reaction_id: number; -}; -type ReactionsDeleteRequestOptions = { +} & RequiredPreview<"squirrel-girl">; + +type ReactionsDeleteLegacyRequestOptions = { method: "DELETE"; - url: Url; + url: "/reactions/:reaction_id"; headers: RequestHeaders; request: RequestRequestOptions; }; + type ReposGetEndpoint = { /** * owner parameter @@ -4806,12 +14993,377 @@ type ReposGetEndpoint = { */ repo: string; }; + type ReposGetRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposGetResponseDataCodeOfConduct = { + key: string; + name: string; + url: string; +}; +type ReposGetResponseDataSourcePermissions = { + admin: boolean; + push: boolean; + pull: boolean; +}; +type ReposGetResponseDataSourceOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposGetResponseDataSource = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: ReposGetResponseDataSourceOwner; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: null; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: Array; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: ReposGetResponseDataSourcePermissions; + allow_rebase_merge: boolean; + template_repository: null; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; +}; +type ReposGetResponseDataParentPermissions = { + admin: boolean; + push: boolean; + pull: boolean; +}; +type ReposGetResponseDataParentOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposGetResponseDataParent = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: ReposGetResponseDataParentOwner; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: null; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: Array; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: ReposGetResponseDataParentPermissions; + allow_rebase_merge: boolean; + template_repository: null; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; +}; +type ReposGetResponseDataOrganization = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposGetResponseDataLicense = { + key: string; + name: string; + spdx_id: string; + url: string; + node_id: string; +}; +type ReposGetResponseDataPermissions = { + pull: boolean; + triage: boolean; + push: boolean; + maintain: boolean; + admin: boolean; +}; +type ReposGetResponseDataOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposGetResponseData = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: ReposGetResponseDataOwner; + private: boolean; + html_url: string; + description: string | null; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string | null; + hooks_url: string; + svn_url: string; + homepage: string | null; + language: null; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template?: boolean; + topics?: Array; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived?: boolean; + disabled?: boolean; + visibility?: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions?: ReposGetResponseDataPermissions; + allow_rebase_merge?: boolean; + template_repository?: null; + temp_clone_token?: string; + allow_squash_merge?: boolean; + allow_merge_commit?: boolean; + subscribers_count: number; + network_count: number; + license?: ReposGetResponseDataLicense; + organization?: ReposGetResponseDataOrganization; + parent?: ReposGetResponseDataParent; + source?: ReposGetResponseDataSource; + forks?: number; + open_issues?: number; + watchers?: number; + code_of_conduct?: ReposGetResponseDataCodeOfConduct; +}; + type ReposUpdateEndpoint = { /** * owner parameter @@ -4834,10 +15386,14 @@ type ReposUpdateEndpoint = { */ homepage?: string; /** - * Either `true` to make the repository private or `false` to make it public. Creating private repositories requires a paid GitHub account. Default: `false`. + * Either `true` to make the repository private or `false` to make it public. Default: `false`. * **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://help.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://help.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. */ private?: boolean; + /** + * Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. The `visibility` parameter overrides the `private` parameter when you use both along with the `nebula-preview` preview header. + */ + visibility?: "public" | "private" | "visibility" | "internal"; /** * Either `true` to enable issues for this repository or `false` to disable them. */ @@ -4870,17 +15426,369 @@ type ReposUpdateEndpoint = { * Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging. */ allow_rebase_merge?: boolean; + /** + * Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion. + */ + delete_branch_on_merge?: boolean; /** * `true` to archive this repository. **Note**: You cannot unarchive repositories through the API. */ archived?: boolean; }; + type ReposUpdateRequestOptions = { method: "PATCH"; - url: Url; + url: "/repos/:owner/:repo"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposUpdateResponseDataSourcePermissions = { + admin: boolean; + push: boolean; + pull: boolean; +}; +type ReposUpdateResponseDataSourceOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposUpdateResponseDataSource = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: ReposUpdateResponseDataSourceOwner; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: null; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: Array; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: ReposUpdateResponseDataSourcePermissions; + allow_rebase_merge: boolean; + template_repository: null; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; +}; +type ReposUpdateResponseDataParentPermissions = { + admin: boolean; + push: boolean; + pull: boolean; +}; +type ReposUpdateResponseDataParentOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposUpdateResponseDataParent = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: ReposUpdateResponseDataParentOwner; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: null; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: Array; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: ReposUpdateResponseDataParentPermissions; + allow_rebase_merge: boolean; + template_repository: null; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; +}; +type ReposUpdateResponseDataOrganization = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposUpdateResponseDataPermissions = { + pull: boolean; + triage: boolean; + push: boolean; + maintain: boolean; + admin: boolean; +}; +type ReposUpdateResponseDataOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposUpdateResponseData = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: ReposUpdateResponseDataOwner; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: null; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: Array; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: ReposUpdateResponseDataPermissions; + allow_rebase_merge: boolean; + template_repository: null; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; + organization: ReposUpdateResponseDataOrganization; + parent: ReposUpdateResponseDataParent; + source: ReposUpdateResponseDataSource; +}; + type ReposDeleteEndpoint = { /** * owner parameter @@ -4891,12 +15799,1420 @@ type ReposDeleteEndpoint = { */ repo: string; }; + type ReposDeleteRequestOptions = { method: "DELETE"; - url: Url; + url: "/repos/:owner/:repo"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposDeleteResponseData = { message: string; documentation_url: string }; + +type ActionsListArtifactsForRepoEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; + +type ActionsListArtifactsForRepoRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/actions/artifacts"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActionsListArtifactsForRepoResponseDataArtifactsItem = { + id: number; + node_id: string; + name: string; + size_in_bytes: number; + url: string; + archive_download_url: string; + expired: boolean; + created_at: string; + expires_at: string; +}; +type ActionsListArtifactsForRepoResponseData = { + total_count: number; + artifacts: Array; +}; + +type ActionsGetArtifactEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * artifact_id parameter + */ + artifact_id: number; +}; + +type ActionsGetArtifactRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/actions/artifacts/:artifact_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActionsGetArtifactResponseData = { + id: number; + node_id: string; + name: string; + size_in_bytes: number; + url: string; + archive_download_url: string; + expired: boolean; + created_at: string; + expires_at: string; +}; + +type ActionsDeleteArtifactEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * artifact_id parameter + */ + artifact_id: number; +}; + +type ActionsDeleteArtifactRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/actions/artifacts/:artifact_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; + +type ActionsDownloadArtifactEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * artifact_id parameter + */ + artifact_id: number; + /** + * archive_format parameter + */ + archive_format: string; +}; + +type ActionsDownloadArtifactRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/actions/artifacts/:artifact_id/:archive_format"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; + +type ActionsGetWorkflowJobEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * job_id parameter + */ + job_id: number; +}; + +type ActionsGetWorkflowJobRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/actions/jobs/:job_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActionsGetWorkflowJobResponseDataStepsItem = { + name: string; + status: string; + conclusion: string; + number: number; + started_at: string; + completed_at: string; +}; +type ActionsGetWorkflowJobResponseData = { + id: number; + run_id: number; + run_url: string; + node_id: string; + head_sha: string; + url: string; + html_url: string; + status: string; + conclusion: string; + started_at: string; + completed_at: string; + name: string; + steps: Array; + check_run_url: string; +}; + +type ActionsDownloadWorkflowJobLogsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * job_id parameter + */ + job_id: number; +}; + +type ActionsDownloadWorkflowJobLogsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/actions/jobs/:job_id/logs"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; + +type ActionsListSelfHostedRunnersForRepoEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; + +type ActionsListSelfHostedRunnersForRepoRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/actions/runners"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActionsListSelfHostedRunnersForRepoResponseDataRunnersItem = { + id: number; + name: string; + os: string; + status: string; +}; +type ActionsListSelfHostedRunnersForRepoResponseData = { + total_count: number; + runners: Array; +}; + +type ActionsListRunnerApplicationsForRepoEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; + +type ActionsListRunnerApplicationsForRepoRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/actions/runners/downloads"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActionsListRunnerApplicationsForRepoResponseDataItem = { + os: string; + architecture: string; + download_url: string; + filename: string; +}; +type ActionsListRunnerApplicationsForRepoResponseData = Array< + ActionsListRunnerApplicationsForRepoResponseDataItem +>; + +type ActionsCreateRegistrationTokenForRepoEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; + +type ActionsCreateRegistrationTokenForRepoRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/actions/runners/registration-token"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActionsCreateRegistrationTokenForRepoResponseData = { + token: string; + expires_at: string; +}; + +type ActionsCreateRemoveTokenForRepoEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; + +type ActionsCreateRemoveTokenForRepoRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/actions/runners/remove-token"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActionsCreateRemoveTokenForRepoResponseData = { + token: string; + expires_at: string; +}; + +type ActionsGetSelfHostedRunnerForRepoEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * runner_id parameter + */ + runner_id: number; +}; + +type ActionsGetSelfHostedRunnerForRepoRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/actions/runners/:runner_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActionsGetSelfHostedRunnerForRepoResponseData = { + id: number; + name: string; + os: string; + status: string; +}; + +type ActionsDeleteSelfHostedRunnerFromRepoEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * runner_id parameter + */ + runner_id: number; +}; + +type ActionsDeleteSelfHostedRunnerFromRepoRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/actions/runners/:runner_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; + +type ActionsListRepoWorkflowRunsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. + */ + actor?: string; + /** + * Returns workflow runs associated with a branch. Use the name of the branch of the `push`. + */ + branch?: string; + /** + * Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)" in the GitHub Help documentation. + */ + event?: string; + /** + * Returns workflow runs associated with the check run `status` or `conclusion` you specify. For example, a conclusion can be `success` or a status can be `completed`. For more information, see the `status` and `conclusion` options available in "[Create a check run](https://developer.github.com/v3/checks/runs/#create-a-check-run)." + */ + status?: "completed" | "status" | "conclusion"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; + +type ActionsListRepoWorkflowRunsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/actions/runs"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActionsListRepoWorkflowRunsResponseDataWorkflowRunsItemHeadRepositoryOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ActionsListRepoWorkflowRunsResponseDataWorkflowRunsItemHeadRepository = { + id: number; + node_id: string; + name: string; + full_name: string; + private: boolean; + owner: ActionsListRepoWorkflowRunsResponseDataWorkflowRunsItemHeadRepositoryOwner; + html_url: string; + description: null; + fork: boolean; + url: string; + forks_url: string; + keys_url: string; + collaborators_url: string; + teams_url: string; + hooks_url: string; + issue_events_url: string; + events_url: string; + assignees_url: string; + branches_url: string; + tags_url: string; + blobs_url: string; + git_tags_url: string; + git_refs_url: string; + trees_url: string; + statuses_url: string; + languages_url: string; + stargazers_url: string; + contributors_url: string; + subscribers_url: string; + subscription_url: string; + commits_url: string; + git_commits_url: string; + comments_url: string; + issue_comment_url: string; + contents_url: string; + compare_url: string; + merges_url: string; + archive_url: string; + downloads_url: string; + issues_url: string; + pulls_url: string; + milestones_url: string; + notifications_url: string; + labels_url: string; + releases_url: string; + deployments_url: string; +}; +type ActionsListRepoWorkflowRunsResponseDataWorkflowRunsItemRepositoryOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ActionsListRepoWorkflowRunsResponseDataWorkflowRunsItemRepository = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: ActionsListRepoWorkflowRunsResponseDataWorkflowRunsItemRepositoryOwner; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; +}; +type ActionsListRepoWorkflowRunsResponseDataWorkflowRunsItemHeadCommitCommitter = { + name: string; + email: string; +}; +type ActionsListRepoWorkflowRunsResponseDataWorkflowRunsItemHeadCommitAuthor = { + name: string; + email: string; +}; +type ActionsListRepoWorkflowRunsResponseDataWorkflowRunsItemHeadCommit = { + id: string; + tree_id: string; + message: string; + timestamp: string; + author: ActionsListRepoWorkflowRunsResponseDataWorkflowRunsItemHeadCommitAuthor; + committer: ActionsListRepoWorkflowRunsResponseDataWorkflowRunsItemHeadCommitCommitter; +}; +type ActionsListRepoWorkflowRunsResponseDataWorkflowRunsItem = { + id: number; + node_id: string; + head_branch: string; + head_sha: string; + run_number: number; + event: string; + status: string; + conclusion: null; + url: string; + html_url: string; + pull_requests: Array; + created_at: string; + updated_at: string; + jobs_url: string; + logs_url: string; + check_suite_url: string; + artifacts_url: string; + cancel_url: string; + rerun_url: string; + workflow_url: string; + head_commit: ActionsListRepoWorkflowRunsResponseDataWorkflowRunsItemHeadCommit; + repository: ActionsListRepoWorkflowRunsResponseDataWorkflowRunsItemRepository; + head_repository: ActionsListRepoWorkflowRunsResponseDataWorkflowRunsItemHeadRepository; +}; +type ActionsListRepoWorkflowRunsResponseData = { + total_count: number; + workflow_runs: Array; +}; + +type ActionsGetWorkflowRunEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * run_id parameter + */ + run_id: number; +}; + +type ActionsGetWorkflowRunRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/actions/runs/:run_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActionsGetWorkflowRunResponseDataHeadRepositoryOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ActionsGetWorkflowRunResponseDataHeadRepository = { + id: number; + node_id: string; + name: string; + full_name: string; + private: boolean; + owner: ActionsGetWorkflowRunResponseDataHeadRepositoryOwner; + html_url: string; + description: null; + fork: boolean; + url: string; + forks_url: string; + keys_url: string; + collaborators_url: string; + teams_url: string; + hooks_url: string; + issue_events_url: string; + events_url: string; + assignees_url: string; + branches_url: string; + tags_url: string; + blobs_url: string; + git_tags_url: string; + git_refs_url: string; + trees_url: string; + statuses_url: string; + languages_url: string; + stargazers_url: string; + contributors_url: string; + subscribers_url: string; + subscription_url: string; + commits_url: string; + git_commits_url: string; + comments_url: string; + issue_comment_url: string; + contents_url: string; + compare_url: string; + merges_url: string; + archive_url: string; + downloads_url: string; + issues_url: string; + pulls_url: string; + milestones_url: string; + notifications_url: string; + labels_url: string; + releases_url: string; + deployments_url: string; +}; +type ActionsGetWorkflowRunResponseDataRepositoryOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ActionsGetWorkflowRunResponseDataRepository = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: ActionsGetWorkflowRunResponseDataRepositoryOwner; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; +}; +type ActionsGetWorkflowRunResponseDataHeadCommitCommitter = { + name: string; + email: string; +}; +type ActionsGetWorkflowRunResponseDataHeadCommitAuthor = { + name: string; + email: string; +}; +type ActionsGetWorkflowRunResponseDataHeadCommit = { + id: string; + tree_id: string; + message: string; + timestamp: string; + author: ActionsGetWorkflowRunResponseDataHeadCommitAuthor; + committer: ActionsGetWorkflowRunResponseDataHeadCommitCommitter; +}; +type ActionsGetWorkflowRunResponseData = { + id: number; + node_id: string; + head_branch: string; + head_sha: string; + run_number: number; + event: string; + status: string; + conclusion: null; + url: string; + html_url: string; + pull_requests: Array; + created_at: string; + updated_at: string; + jobs_url: string; + logs_url: string; + check_suite_url: string; + artifacts_url: string; + cancel_url: string; + rerun_url: string; + workflow_url: string; + head_commit: ActionsGetWorkflowRunResponseDataHeadCommit; + repository: ActionsGetWorkflowRunResponseDataRepository; + head_repository: ActionsGetWorkflowRunResponseDataHeadRepository; +}; + +type ActionsListWorkflowRunArtifactsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * run_id parameter + */ + run_id: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; + +type ActionsListWorkflowRunArtifactsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/actions/runs/:run_id/artifacts"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActionsListWorkflowRunArtifactsResponseDataArtifactsItem = { + id: number; + node_id: string; + name: string; + size_in_bytes: number; + url: string; + archive_download_url: string; + expired: boolean; + created_at: string; + expires_at: string; +}; +type ActionsListWorkflowRunArtifactsResponseData = { + total_count: number; + artifacts: Array; +}; + +type ActionsCancelWorkflowRunEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * run_id parameter + */ + run_id: number; +}; + +type ActionsCancelWorkflowRunRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/actions/runs/:run_id/cancel"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; + +type ActionsListJobsForWorkflowRunEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * run_id parameter + */ + run_id: number; + /** + * Filters jobs by their `completed_at` timestamp. Can be one of: + * \* `latest`: Returns jobs from the most recent execution of the workflow run. + * \* `all`: Returns all jobs for a workflow run, including from old executions of the workflow run. + */ + filter?: "latest" | "all"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; + +type ActionsListJobsForWorkflowRunRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/actions/runs/:run_id/jobs"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActionsListJobsForWorkflowRunResponseDataJobsItemStepsItem = { + name: string; + status: string; + conclusion: string; + number: number; + started_at: string; + completed_at: string; +}; +type ActionsListJobsForWorkflowRunResponseDataJobsItem = { + id: number; + run_id: number; + run_url: string; + node_id: string; + head_sha: string; + url: string; + html_url: string; + status: string; + conclusion: string; + started_at: string; + completed_at: string; + name: string; + steps: Array; + check_run_url: string; +}; +type ActionsListJobsForWorkflowRunResponseData = { + total_count: number; + jobs: Array; +}; + +type ActionsDownloadWorkflowRunLogsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * run_id parameter + */ + run_id: number; +}; + +type ActionsDownloadWorkflowRunLogsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/actions/runs/:run_id/logs"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; + +type ActionsDeleteWorkflowRunLogsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * run_id parameter + */ + run_id: number; +}; + +type ActionsDeleteWorkflowRunLogsRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/actions/runs/:run_id/logs"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; + +type ActionsReRunWorkflowEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * run_id parameter + */ + run_id: number; +}; + +type ActionsReRunWorkflowRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/actions/runs/:run_id/rerun"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; + +type ActionsListSecretsForRepoEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; + +type ActionsListSecretsForRepoRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/actions/secrets"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActionsListSecretsForRepoResponseDataSecretsItem = { + name: string; + created_at: string; + updated_at: string; +}; +type ActionsListSecretsForRepoResponseData = { + total_count: number; + secrets: Array; +}; + +type ActionsGetPublicKeyEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; + +type ActionsGetPublicKeyRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/actions/secrets/public-key"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActionsGetPublicKeyResponseData = { key_id: string; key: string }; + +type ActionsGetSecretEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * name parameter + */ + name: string; +}; + +type ActionsGetSecretRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/actions/secrets/:name"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActionsGetSecretResponseData = { + name: string; + created_at: string; + updated_at: string; +}; + +type ActionsCreateOrUpdateSecretForRepoEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * name parameter + */ + name: string; + /** + * Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get your public key](https://developer.github.com/v3/actions/secrets/#get-your-public-key) endpoint. + */ + encrypted_value?: string; + /** + * ID of the key you used to encrypt the secret. + */ + key_id?: string; +}; + +type ActionsCreateOrUpdateSecretForRepoRequestOptions = { + method: "PUT"; + url: "/repos/:owner/:repo/actions/secrets/:name"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; + +type ActionsDeleteSecretFromRepoEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * name parameter + */ + name: string; +}; + +type ActionsDeleteSecretFromRepoRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/actions/secrets/:name"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; + +type ActionsListRepoWorkflowsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; + +type ActionsListRepoWorkflowsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/actions/workflows"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActionsListRepoWorkflowsResponseDataWorkflowsItem = { + id: number; + node_id: string; + name: string; + path: string; + state: string; + created_at: string; + updated_at: string; + url: string; + html_url: string; + badge_url: string; +}; +type ActionsListRepoWorkflowsResponseData = { + total_count: number; + workflows: Array; +}; + +type ActionsGetWorkflowEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * workflow_id parameter + */ + workflow_id: number; +}; + +type ActionsGetWorkflowRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/actions/workflows/:workflow_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActionsGetWorkflowResponseData = { + id: number; + node_id: string; + name: string; + path: string; + state: string; + created_at: string; + updated_at: string; + url: string; + html_url: string; + badge_url: string; +}; + +type ActionsListWorkflowRunsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * workflow_id parameter + */ + workflow_id: number; + /** + * Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. + */ + actor?: string; + /** + * Returns workflow runs associated with a branch. Use the name of the branch of the `push`. + */ + branch?: string; + /** + * Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)" in the GitHub Help documentation. + */ + event?: string; + /** + * Returns workflow runs associated with the check run `status` or `conclusion` you specify. For example, a conclusion can be `success` or a status can be `completed`. For more information, see the `status` and `conclusion` options available in "[Create a check run](https://developer.github.com/v3/checks/runs/#create-a-check-run)." + */ + status?: "completed" | "status" | "conclusion"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; + +type ActionsListWorkflowRunsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/actions/workflows/:workflow_id/runs"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActionsListWorkflowRunsResponseDataWorkflowRunsItemHeadRepositoryOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ActionsListWorkflowRunsResponseDataWorkflowRunsItemHeadRepository = { + id: number; + node_id: string; + name: string; + full_name: string; + private: boolean; + owner: ActionsListWorkflowRunsResponseDataWorkflowRunsItemHeadRepositoryOwner; + html_url: string; + description: null; + fork: boolean; + url: string; + forks_url: string; + keys_url: string; + collaborators_url: string; + teams_url: string; + hooks_url: string; + issue_events_url: string; + events_url: string; + assignees_url: string; + branches_url: string; + tags_url: string; + blobs_url: string; + git_tags_url: string; + git_refs_url: string; + trees_url: string; + statuses_url: string; + languages_url: string; + stargazers_url: string; + contributors_url: string; + subscribers_url: string; + subscription_url: string; + commits_url: string; + git_commits_url: string; + comments_url: string; + issue_comment_url: string; + contents_url: string; + compare_url: string; + merges_url: string; + archive_url: string; + downloads_url: string; + issues_url: string; + pulls_url: string; + milestones_url: string; + notifications_url: string; + labels_url: string; + releases_url: string; + deployments_url: string; +}; +type ActionsListWorkflowRunsResponseDataWorkflowRunsItemRepositoryOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ActionsListWorkflowRunsResponseDataWorkflowRunsItemRepository = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: ActionsListWorkflowRunsResponseDataWorkflowRunsItemRepositoryOwner; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; +}; +type ActionsListWorkflowRunsResponseDataWorkflowRunsItemHeadCommitCommitter = { + name: string; + email: string; +}; +type ActionsListWorkflowRunsResponseDataWorkflowRunsItemHeadCommitAuthor = { + name: string; + email: string; +}; +type ActionsListWorkflowRunsResponseDataWorkflowRunsItemHeadCommit = { + id: string; + tree_id: string; + message: string; + timestamp: string; + author: ActionsListWorkflowRunsResponseDataWorkflowRunsItemHeadCommitAuthor; + committer: ActionsListWorkflowRunsResponseDataWorkflowRunsItemHeadCommitCommitter; +}; +type ActionsListWorkflowRunsResponseDataWorkflowRunsItem = { + id: number; + node_id: string; + head_branch: string; + head_sha: string; + run_number: number; + event: string; + status: string; + conclusion: null; + url: string; + html_url: string; + pull_requests: Array; + created_at: string; + updated_at: string; + jobs_url: string; + logs_url: string; + check_suite_url: string; + artifacts_url: string; + cancel_url: string; + rerun_url: string; + workflow_url: string; + head_commit: ActionsListWorkflowRunsResponseDataWorkflowRunsItemHeadCommit; + repository: ActionsListWorkflowRunsResponseDataWorkflowRunsItemRepository; + head_repository: ActionsListWorkflowRunsResponseDataWorkflowRunsItemHeadRepository; +}; +type ActionsListWorkflowRunsResponseData = { + total_count: number; + workflow_runs: Array; +}; + type IssuesListAssigneesEndpoint = { /** * owner parameter @@ -4915,12 +17231,37 @@ type IssuesListAssigneesEndpoint = { */ page?: number; }; + type IssuesListAssigneesRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/assignees"; headers: RequestHeaders; request: RequestRequestOptions; }; +type IssuesListAssigneesResponseDataItem = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type IssuesListAssigneesResponseData = Array< + IssuesListAssigneesResponseDataItem +>; + type IssuesCheckAssigneeEndpoint = { /** * owner parameter @@ -4935,12 +17276,14 @@ type IssuesCheckAssigneeEndpoint = { */ assignee: string; }; + type IssuesCheckAssigneeRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/assignees/:assignee"; headers: RequestHeaders; request: RequestRequestOptions; }; + type ReposEnableAutomatedSecurityFixesEndpoint = { /** * owner parameter @@ -4950,13 +17293,15 @@ type ReposEnableAutomatedSecurityFixesEndpoint = { * repo parameter */ repo: string; -}; +} & RequiredPreview<"london">; + type ReposEnableAutomatedSecurityFixesRequestOptions = { method: "PUT"; - url: Url; + url: "/repos/:owner/:repo/automated-security-fixes"; headers: RequestHeaders; request: RequestRequestOptions; }; + type ReposDisableAutomatedSecurityFixesEndpoint = { /** * owner parameter @@ -4966,13 +17311,15 @@ type ReposDisableAutomatedSecurityFixesEndpoint = { * repo parameter */ repo: string; -}; +} & RequiredPreview<"london">; + type ReposDisableAutomatedSecurityFixesRequestOptions = { method: "DELETE"; - url: Url; + url: "/repos/:owner/:repo/automated-security-fixes"; headers: RequestHeaders; request: RequestRequestOptions; }; + type ReposListBranchesEndpoint = { /** * owner parameter @@ -4995,12 +17342,31 @@ type ReposListBranchesEndpoint = { */ page?: number; }; + type ReposListBranchesRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/branches"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposListBranchesResponseDataItemProtectionRequiredStatusChecks = { + enforcement_level: string; + contexts: Array; +}; +type ReposListBranchesResponseDataItemProtection = { + enabled: boolean; + required_status_checks: ReposListBranchesResponseDataItemProtectionRequiredStatusChecks; +}; +type ReposListBranchesResponseDataItemCommit = { sha: string; url: string }; +type ReposListBranchesResponseDataItem = { + name: string; + commit: ReposListBranchesResponseDataItemCommit; + protected: boolean; + protection: ReposListBranchesResponseDataItemProtection; + protection_url: string; +}; +type ReposListBranchesResponseData = Array; + type ReposGetBranchEndpoint = { /** * owner parameter @@ -5015,12 +17381,80 @@ type ReposGetBranchEndpoint = { */ branch: string; }; + type ReposGetBranchRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/branches/:branch"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposGetBranchResponseDataProtectionRequiredStatusChecks = { + enforcement_level: string; + contexts: Array; +}; +type ReposGetBranchResponseDataProtection = { + enabled: boolean; + required_status_checks: ReposGetBranchResponseDataProtectionRequiredStatusChecks; +}; +type ReposGetBranchResponseDataLinks = { html: string; self: string }; +type ReposGetBranchResponseDataCommitCommitter = { + gravatar_id: string; + avatar_url: string; + url: string; + id: number; + login: string; +}; +type ReposGetBranchResponseDataCommitParentsItem = { sha: string; url: string }; +type ReposGetBranchResponseDataCommitAuthor = { + gravatar_id: string; + avatar_url: string; + url: string; + id: number; + login: string; +}; +type ReposGetBranchResponseDataCommitCommitVerification = { + verified: boolean; + reason: string; + signature: null; + payload: null; +}; +type ReposGetBranchResponseDataCommitCommitCommitter = { + name: string; + date: string; + email: string; +}; +type ReposGetBranchResponseDataCommitCommitTree = { sha: string; url: string }; +type ReposGetBranchResponseDataCommitCommitAuthor = { + name: string; + date: string; + email: string; +}; +type ReposGetBranchResponseDataCommitCommit = { + author: ReposGetBranchResponseDataCommitCommitAuthor; + url: string; + message: string; + tree: ReposGetBranchResponseDataCommitCommitTree; + committer: ReposGetBranchResponseDataCommitCommitCommitter; + verification: ReposGetBranchResponseDataCommitCommitVerification; +}; +type ReposGetBranchResponseDataCommit = { + sha: string; + node_id: string; + commit: ReposGetBranchResponseDataCommitCommit; + author: ReposGetBranchResponseDataCommitAuthor; + parents: Array; + url: string; + committer: ReposGetBranchResponseDataCommitCommitter; +}; +type ReposGetBranchResponseData = { + name: string; + commit: ReposGetBranchResponseDataCommit; + _links: ReposGetBranchResponseDataLinks; + protected: boolean; + protection: ReposGetBranchResponseDataProtection; + protection_url: string; +}; + type ReposGetBranchProtectionEndpoint = { /** * owner parameter @@ -5035,12 +17469,170 @@ type ReposGetBranchProtectionEndpoint = { */ branch: string; }; + type ReposGetBranchProtectionRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/branches/:branch/protection"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposGetBranchProtectionResponseDataAllowDeletions = { enabled: boolean }; +type ReposGetBranchProtectionResponseDataAllowForcePushes = { + enabled: boolean; +}; +type ReposGetBranchProtectionResponseDataRequiredLinearHistory = { + enabled: boolean; +}; +type ReposGetBranchProtectionResponseDataRestrictionsAppsItemPermissions = { + metadata: string; + contents: string; + issues: string; + single_file: string; +}; +type ReposGetBranchProtectionResponseDataRestrictionsAppsItemOwner = { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; +}; +type ReposGetBranchProtectionResponseDataRestrictionsAppsItem = { + id: number; + slug: string; + node_id: string; + owner: ReposGetBranchProtectionResponseDataRestrictionsAppsItemOwner; + name: string; + description: string; + external_url: string; + html_url: string; + created_at: string; + updated_at: string; + permissions: ReposGetBranchProtectionResponseDataRestrictionsAppsItemPermissions; + events: Array; +}; +type ReposGetBranchProtectionResponseDataRestrictionsTeamsItem = { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: null; +}; +type ReposGetBranchProtectionResponseDataRestrictionsUsersItem = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposGetBranchProtectionResponseDataRestrictions = { + url: string; + users_url: string; + teams_url: string; + apps_url: string; + users: Array; + teams: Array; + apps: Array; +}; +type ReposGetBranchProtectionResponseDataRequiredPullRequestReviewsDismissalRestrictionsTeamsItem = { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: null; +}; +type ReposGetBranchProtectionResponseDataRequiredPullRequestReviewsDismissalRestrictionsUsersItem = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposGetBranchProtectionResponseDataRequiredPullRequestReviewsDismissalRestrictions = { + url: string; + users_url: string; + teams_url: string; + users: Array< + ReposGetBranchProtectionResponseDataRequiredPullRequestReviewsDismissalRestrictionsUsersItem + >; + teams: Array< + ReposGetBranchProtectionResponseDataRequiredPullRequestReviewsDismissalRestrictionsTeamsItem + >; +}; +type ReposGetBranchProtectionResponseDataRequiredPullRequestReviews = { + url: string; + dismissal_restrictions: ReposGetBranchProtectionResponseDataRequiredPullRequestReviewsDismissalRestrictions; + dismiss_stale_reviews: boolean; + require_code_owner_reviews: boolean; + required_approving_review_count: number; +}; +type ReposGetBranchProtectionResponseDataEnforceAdmins = { + url: string; + enabled: boolean; +}; +type ReposGetBranchProtectionResponseDataRequiredStatusChecks = { + url: string; + strict: boolean; + contexts: Array; + contexts_url: string; +}; +type ReposGetBranchProtectionResponseData = { + url: string; + required_status_checks: ReposGetBranchProtectionResponseDataRequiredStatusChecks; + enforce_admins: ReposGetBranchProtectionResponseDataEnforceAdmins; + required_pull_request_reviews: ReposGetBranchProtectionResponseDataRequiredPullRequestReviews; + restrictions: ReposGetBranchProtectionResponseDataRestrictions; + required_linear_history: ReposGetBranchProtectionResponseDataRequiredLinearHistory; + allow_force_pushes: ReposGetBranchProtectionResponseDataAllowForcePushes; + allow_deletions: ReposGetBranchProtectionResponseDataAllowDeletions; +}; + type ReposUpdateBranchProtectionEndpoint = { /** * owner parameter @@ -5067,16 +17659,188 @@ type ReposUpdateBranchProtectionEndpoint = { */ required_pull_request_reviews: ReposUpdateBranchProtectionParamsRequiredPullRequestReviews | null; /** - * Restrict who can push to this branch. User, app, and team `restrictions` are only available for organization-owned repositories. Set to `null` to disable. + * Restrict who can push to the protected branch. User, app, and team `restrictions` are only available for organization-owned repositories. Set to `null` to disable. */ restrictions: ReposUpdateBranchProtectionParamsRestrictions | null; + /** + * Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to `true` to enforce a linear commit history. Set to `false` to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: `false`. For more information, see "[Requiring a linear commit history](https://help.github.com/github/administering-a-repository/requiring-a-linear-commit-history)" in the GitHub Help documentation. + */ + required_linear_history?: boolean; + /** + * Permits force pushes to the protected branch by anyone with write access to the repository. Set to `true` to allow force pushes. Set to `false` or `null` to block force pushes. Default: `false`. For more information, see "[Enabling force pushes to a protected branch](https://help.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" in the GitHub Help documentation." + */ + allow_force_pushes?: boolean | null; + /** + * Allows deletion of the protected branch by anyone with write access to the repository. Set to `false` to prevent deletion of the protected branch. Default: `false`. For more information, see "[Enabling force pushes to a protected branch](https://help.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" in the GitHub Help documentation. + */ + allow_deletions?: boolean; }; + type ReposUpdateBranchProtectionRequestOptions = { method: "PUT"; - url: Url; + url: "/repos/:owner/:repo/branches/:branch/protection"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposUpdateBranchProtectionResponseDataAllowDeletions = { + enabled: boolean; +}; +type ReposUpdateBranchProtectionResponseDataAllowForcePushes = { + enabled: boolean; +}; +type ReposUpdateBranchProtectionResponseDataRequiredLinearHistory = { + enabled: boolean; +}; +type ReposUpdateBranchProtectionResponseDataRestrictionsAppsItemPermissions = { + metadata: string; + contents: string; + issues: string; + single_file: string; +}; +type ReposUpdateBranchProtectionResponseDataRestrictionsAppsItemOwner = { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; +}; +type ReposUpdateBranchProtectionResponseDataRestrictionsAppsItem = { + id: number; + slug: string; + node_id: string; + owner: ReposUpdateBranchProtectionResponseDataRestrictionsAppsItemOwner; + name: string; + description: string; + external_url: string; + html_url: string; + created_at: string; + updated_at: string; + permissions: ReposUpdateBranchProtectionResponseDataRestrictionsAppsItemPermissions; + events: Array; +}; +type ReposUpdateBranchProtectionResponseDataRestrictionsTeamsItem = { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: null; +}; +type ReposUpdateBranchProtectionResponseDataRestrictionsUsersItem = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposUpdateBranchProtectionResponseDataRestrictions = { + url: string; + users_url: string; + teams_url: string; + apps_url: string; + users: Array; + teams: Array; + apps: Array; +}; +type ReposUpdateBranchProtectionResponseDataRequiredPullRequestReviewsDismissalRestrictionsTeamsItem = { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: null; +}; +type ReposUpdateBranchProtectionResponseDataRequiredPullRequestReviewsDismissalRestrictionsUsersItem = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposUpdateBranchProtectionResponseDataRequiredPullRequestReviewsDismissalRestrictions = { + url: string; + users_url: string; + teams_url: string; + users: Array< + ReposUpdateBranchProtectionResponseDataRequiredPullRequestReviewsDismissalRestrictionsUsersItem + >; + teams: Array< + ReposUpdateBranchProtectionResponseDataRequiredPullRequestReviewsDismissalRestrictionsTeamsItem + >; +}; +type ReposUpdateBranchProtectionResponseDataRequiredPullRequestReviews = { + url: string; + dismissal_restrictions: ReposUpdateBranchProtectionResponseDataRequiredPullRequestReviewsDismissalRestrictions; + dismiss_stale_reviews: boolean; + require_code_owner_reviews: boolean; + required_approving_review_count: number; +}; +type ReposUpdateBranchProtectionResponseDataEnforceAdmins = { + url: string; + enabled: boolean; +}; +type ReposUpdateBranchProtectionResponseDataRequiredStatusChecks = { + url: string; + strict: boolean; + contexts: Array; + contexts_url: string; +}; +type ReposUpdateBranchProtectionResponseData = { + url: string; + required_status_checks: ReposUpdateBranchProtectionResponseDataRequiredStatusChecks; + enforce_admins: ReposUpdateBranchProtectionResponseDataEnforceAdmins; + required_pull_request_reviews: ReposUpdateBranchProtectionResponseDataRequiredPullRequestReviews; + restrictions: ReposUpdateBranchProtectionResponseDataRestrictions; + required_linear_history: ReposUpdateBranchProtectionResponseDataRequiredLinearHistory; + allow_force_pushes: ReposUpdateBranchProtectionResponseDataAllowForcePushes; + allow_deletions: ReposUpdateBranchProtectionResponseDataAllowDeletions; +}; + type ReposRemoveBranchProtectionEndpoint = { /** * owner parameter @@ -5091,12 +17855,14 @@ type ReposRemoveBranchProtectionEndpoint = { */ branch: string; }; + type ReposRemoveBranchProtectionRequestOptions = { method: "DELETE"; - url: Url; + url: "/repos/:owner/:repo/branches/:branch/protection"; headers: RequestHeaders; request: RequestRequestOptions; }; + type ReposGetProtectedBranchAdminEnforcementEndpoint = { /** * owner parameter @@ -5111,12 +17877,18 @@ type ReposGetProtectedBranchAdminEnforcementEndpoint = { */ branch: string; }; + type ReposGetProtectedBranchAdminEnforcementRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/branches/:branch/protection/enforce_admins"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposGetProtectedBranchAdminEnforcementResponseData = { + url: string; + enabled: boolean; +}; + type ReposAddProtectedBranchAdminEnforcementEndpoint = { /** * owner parameter @@ -5131,12 +17903,18 @@ type ReposAddProtectedBranchAdminEnforcementEndpoint = { */ branch: string; }; + type ReposAddProtectedBranchAdminEnforcementRequestOptions = { method: "POST"; - url: Url; + url: "/repos/:owner/:repo/branches/:branch/protection/enforce_admins"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposAddProtectedBranchAdminEnforcementResponseData = { + url: string; + enabled: boolean; +}; + type ReposRemoveProtectedBranchAdminEnforcementEndpoint = { /** * owner parameter @@ -5151,12 +17929,14 @@ type ReposRemoveProtectedBranchAdminEnforcementEndpoint = { */ branch: string; }; + type ReposRemoveProtectedBranchAdminEnforcementRequestOptions = { method: "DELETE"; - url: Url; + url: "/repos/:owner/:repo/branches/:branch/protection/enforce_admins"; headers: RequestHeaders; request: RequestRequestOptions; }; + type ReposGetProtectedBranchPullRequestReviewEnforcementEndpoint = { /** * owner parameter @@ -5171,12 +17951,66 @@ type ReposGetProtectedBranchPullRequestReviewEnforcementEndpoint = { */ branch: string; }; + type ReposGetProtectedBranchPullRequestReviewEnforcementRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposGetProtectedBranchPullRequestReviewEnforcementResponseDataDismissalRestrictionsTeamsItem = { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: null; +}; +type ReposGetProtectedBranchPullRequestReviewEnforcementResponseDataDismissalRestrictionsUsersItem = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposGetProtectedBranchPullRequestReviewEnforcementResponseDataDismissalRestrictions = { + url: string; + users_url: string; + teams_url: string; + users: Array< + ReposGetProtectedBranchPullRequestReviewEnforcementResponseDataDismissalRestrictionsUsersItem + >; + teams: Array< + ReposGetProtectedBranchPullRequestReviewEnforcementResponseDataDismissalRestrictionsTeamsItem + >; +}; +type ReposGetProtectedBranchPullRequestReviewEnforcementResponseData = { + url: string; + dismissal_restrictions: ReposGetProtectedBranchPullRequestReviewEnforcementResponseDataDismissalRestrictions; + dismiss_stale_reviews: boolean; + require_code_owner_reviews: boolean; + required_approving_review_count: number; +}; + type ReposUpdateProtectedBranchPullRequestReviewEnforcementEndpoint = { /** * owner parameter @@ -5207,12 +18041,66 @@ type ReposUpdateProtectedBranchPullRequestReviewEnforcementEndpoint = { */ required_approving_review_count?: number; }; + type ReposUpdateProtectedBranchPullRequestReviewEnforcementRequestOptions = { method: "PATCH"; - url: Url; + url: "/repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposUpdateProtectedBranchPullRequestReviewEnforcementResponseDataDismissalRestrictionsTeamsItem = { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: null; +}; +type ReposUpdateProtectedBranchPullRequestReviewEnforcementResponseDataDismissalRestrictionsUsersItem = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposUpdateProtectedBranchPullRequestReviewEnforcementResponseDataDismissalRestrictions = { + url: string; + users_url: string; + teams_url: string; + users: Array< + ReposUpdateProtectedBranchPullRequestReviewEnforcementResponseDataDismissalRestrictionsUsersItem + >; + teams: Array< + ReposUpdateProtectedBranchPullRequestReviewEnforcementResponseDataDismissalRestrictionsTeamsItem + >; +}; +type ReposUpdateProtectedBranchPullRequestReviewEnforcementResponseData = { + url: string; + dismissal_restrictions: ReposUpdateProtectedBranchPullRequestReviewEnforcementResponseDataDismissalRestrictions; + dismiss_stale_reviews: boolean; + require_code_owner_reviews: boolean; + required_approving_review_count: number; +}; + type ReposRemoveProtectedBranchPullRequestReviewEnforcementEndpoint = { /** * owner parameter @@ -5227,12 +18115,14 @@ type ReposRemoveProtectedBranchPullRequestReviewEnforcementEndpoint = { */ branch: string; }; + type ReposRemoveProtectedBranchPullRequestReviewEnforcementRequestOptions = { method: "DELETE"; - url: Url; + url: "/repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews"; headers: RequestHeaders; request: RequestRequestOptions; }; + type ReposGetProtectedBranchRequiredSignaturesEndpoint = { /** * owner parameter @@ -5246,13 +18136,19 @@ type ReposGetProtectedBranchRequiredSignaturesEndpoint = { * branch parameter */ branch: string; -}; +} & RequiredPreview<"zzzax">; + type ReposGetProtectedBranchRequiredSignaturesRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/branches/:branch/protection/required_signatures"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposGetProtectedBranchRequiredSignaturesResponseData = { + url: string; + enabled: boolean; +}; + type ReposAddProtectedBranchRequiredSignaturesEndpoint = { /** * owner parameter @@ -5266,13 +18162,19 @@ type ReposAddProtectedBranchRequiredSignaturesEndpoint = { * branch parameter */ branch: string; -}; +} & RequiredPreview<"zzzax">; + type ReposAddProtectedBranchRequiredSignaturesRequestOptions = { method: "POST"; - url: Url; + url: "/repos/:owner/:repo/branches/:branch/protection/required_signatures"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposAddProtectedBranchRequiredSignaturesResponseData = { + url: string; + enabled: boolean; +}; + type ReposRemoveProtectedBranchRequiredSignaturesEndpoint = { /** * owner parameter @@ -5286,13 +18188,15 @@ type ReposRemoveProtectedBranchRequiredSignaturesEndpoint = { * branch parameter */ branch: string; -}; +} & RequiredPreview<"zzzax">; + type ReposRemoveProtectedBranchRequiredSignaturesRequestOptions = { method: "DELETE"; - url: Url; + url: "/repos/:owner/:repo/branches/:branch/protection/required_signatures"; headers: RequestHeaders; request: RequestRequestOptions; }; + type ReposGetProtectedBranchRequiredStatusChecksEndpoint = { /** * owner parameter @@ -5307,12 +18211,20 @@ type ReposGetProtectedBranchRequiredStatusChecksEndpoint = { */ branch: string; }; + type ReposGetProtectedBranchRequiredStatusChecksRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/branches/:branch/protection/required_status_checks"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposGetProtectedBranchRequiredStatusChecksResponseData = { + url: string; + strict: boolean; + contexts: Array; + contexts_url: string; +}; + type ReposUpdateProtectedBranchRequiredStatusChecksEndpoint = { /** * owner parameter @@ -5335,12 +18247,20 @@ type ReposUpdateProtectedBranchRequiredStatusChecksEndpoint = { */ contexts?: string[]; }; + type ReposUpdateProtectedBranchRequiredStatusChecksRequestOptions = { method: "PATCH"; - url: Url; + url: "/repos/:owner/:repo/branches/:branch/protection/required_status_checks"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposUpdateProtectedBranchRequiredStatusChecksResponseData = { + url: string; + strict: boolean; + contexts: Array; + contexts_url: string; +}; + type ReposRemoveProtectedBranchRequiredStatusChecksEndpoint = { /** * owner parameter @@ -5355,12 +18275,14 @@ type ReposRemoveProtectedBranchRequiredStatusChecksEndpoint = { */ branch: string; }; + type ReposRemoveProtectedBranchRequiredStatusChecksRequestOptions = { method: "DELETE"; - url: Url; + url: "/repos/:owner/:repo/branches/:branch/protection/required_status_checks"; headers: RequestHeaders; request: RequestRequestOptions; }; + type ReposListProtectedBranchRequiredStatusChecksContextsEndpoint = { /** * owner parameter @@ -5375,12 +18297,17 @@ type ReposListProtectedBranchRequiredStatusChecksContextsEndpoint = { */ branch: string; }; + type ReposListProtectedBranchRequiredStatusChecksContextsRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposListProtectedBranchRequiredStatusChecksContextsResponseData = Array< + string +>; + type ReposReplaceProtectedBranchRequiredStatusChecksContextsEndpoint = { /** * owner parameter @@ -5399,12 +18326,17 @@ type ReposReplaceProtectedBranchRequiredStatusChecksContextsEndpoint = { */ contexts: string[]; }; + type ReposReplaceProtectedBranchRequiredStatusChecksContextsRequestOptions = { method: "PUT"; - url: Url; + url: "/repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposReplaceProtectedBranchRequiredStatusChecksContextsResponseData = Array< + string +>; + type ReposAddProtectedBranchRequiredStatusChecksContextsEndpoint = { /** * owner parameter @@ -5423,12 +18355,17 @@ type ReposAddProtectedBranchRequiredStatusChecksContextsEndpoint = { */ contexts: string[]; }; + type ReposAddProtectedBranchRequiredStatusChecksContextsRequestOptions = { method: "POST"; - url: Url; + url: "/repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposAddProtectedBranchRequiredStatusChecksContextsResponseData = Array< + string +>; + type ReposRemoveProtectedBranchRequiredStatusChecksContextsEndpoint = { /** * owner parameter @@ -5447,12 +18384,17 @@ type ReposRemoveProtectedBranchRequiredStatusChecksContextsEndpoint = { */ contexts: string[]; }; + type ReposRemoveProtectedBranchRequiredStatusChecksContextsRequestOptions = { method: "DELETE"; - url: Url; + url: "/repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposRemoveProtectedBranchRequiredStatusChecksContextsResponseData = Array< + string +>; + type ReposGetProtectedBranchRestrictionsEndpoint = { /** * owner parameter @@ -5467,12 +18409,91 @@ type ReposGetProtectedBranchRestrictionsEndpoint = { */ branch: string; }; + type ReposGetProtectedBranchRestrictionsRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/branches/:branch/protection/restrictions"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposGetProtectedBranchRestrictionsResponseDataAppsItemPermissions = { + metadata: string; + contents: string; + issues: string; + single_file: string; +}; +type ReposGetProtectedBranchRestrictionsResponseDataAppsItemOwner = { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; +}; +type ReposGetProtectedBranchRestrictionsResponseDataAppsItem = { + id: number; + slug: string; + node_id: string; + owner: ReposGetProtectedBranchRestrictionsResponseDataAppsItemOwner; + name: string; + description: string; + external_url: string; + html_url: string; + created_at: string; + updated_at: string; + permissions: ReposGetProtectedBranchRestrictionsResponseDataAppsItemPermissions; + events: Array; +}; +type ReposGetProtectedBranchRestrictionsResponseDataTeamsItem = { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: null; +}; +type ReposGetProtectedBranchRestrictionsResponseDataUsersItem = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposGetProtectedBranchRestrictionsResponseData = { + url: string; + users_url: string; + teams_url: string; + apps_url: string; + users: Array; + teams: Array; + apps: Array; +}; + type ReposRemoveProtectedBranchRestrictionsEndpoint = { /** * owner parameter @@ -5487,12 +18508,14 @@ type ReposRemoveProtectedBranchRestrictionsEndpoint = { */ branch: string; }; + type ReposRemoveProtectedBranchRestrictionsRequestOptions = { method: "DELETE"; - url: Url; + url: "/repos/:owner/:repo/branches/:branch/protection/restrictions"; headers: RequestHeaders; request: RequestRequestOptions; }; + type ReposGetAppsWithAccessToProtectedBranchEndpoint = { /** * owner parameter @@ -5507,32 +18530,51 @@ type ReposGetAppsWithAccessToProtectedBranchEndpoint = { */ branch: string; }; + type ReposGetAppsWithAccessToProtectedBranchRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/apps"; headers: RequestHeaders; request: RequestRequestOptions; }; -type ReposListAppsWithAccessToProtectedBranchEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * branch parameter - */ - branch: string; +type ReposGetAppsWithAccessToProtectedBranchResponseDataItemPermissions = { + metadata: string; + contents: string; + issues: string; + single_file: string; }; -type ReposListAppsWithAccessToProtectedBranchRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; +type ReposGetAppsWithAccessToProtectedBranchResponseDataItemOwner = { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; }; +type ReposGetAppsWithAccessToProtectedBranchResponseDataItem = { + id: number; + slug: string; + node_id: string; + owner: ReposGetAppsWithAccessToProtectedBranchResponseDataItemOwner; + name: string; + description: string; + external_url: string; + html_url: string; + created_at: string; + updated_at: string; + permissions: ReposGetAppsWithAccessToProtectedBranchResponseDataItemPermissions; + events: Array; +}; +type ReposGetAppsWithAccessToProtectedBranchResponseData = Array< + ReposGetAppsWithAccessToProtectedBranchResponseDataItem +>; + type ReposReplaceProtectedBranchAppRestrictionsEndpoint = { /** * owner parameter @@ -5551,12 +18593,51 @@ type ReposReplaceProtectedBranchAppRestrictionsEndpoint = { */ apps: string[]; }; + type ReposReplaceProtectedBranchAppRestrictionsRequestOptions = { method: "PUT"; - url: Url; + url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/apps"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposReplaceProtectedBranchAppRestrictionsResponseDataItemPermissions = { + metadata: string; + contents: string; + issues: string; + single_file: string; +}; +type ReposReplaceProtectedBranchAppRestrictionsResponseDataItemOwner = { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; +}; +type ReposReplaceProtectedBranchAppRestrictionsResponseDataItem = { + id: number; + slug: string; + node_id: string; + owner: ReposReplaceProtectedBranchAppRestrictionsResponseDataItemOwner; + name: string; + description: string; + external_url: string; + html_url: string; + created_at: string; + updated_at: string; + permissions: ReposReplaceProtectedBranchAppRestrictionsResponseDataItemPermissions; + events: Array; +}; +type ReposReplaceProtectedBranchAppRestrictionsResponseData = Array< + ReposReplaceProtectedBranchAppRestrictionsResponseDataItem +>; + type ReposAddProtectedBranchAppRestrictionsEndpoint = { /** * owner parameter @@ -5575,12 +18656,51 @@ type ReposAddProtectedBranchAppRestrictionsEndpoint = { */ apps: string[]; }; + type ReposAddProtectedBranchAppRestrictionsRequestOptions = { method: "POST"; - url: Url; + url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/apps"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposAddProtectedBranchAppRestrictionsResponseDataItemPermissions = { + metadata: string; + contents: string; + issues: string; + single_file: string; +}; +type ReposAddProtectedBranchAppRestrictionsResponseDataItemOwner = { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; +}; +type ReposAddProtectedBranchAppRestrictionsResponseDataItem = { + id: number; + slug: string; + node_id: string; + owner: ReposAddProtectedBranchAppRestrictionsResponseDataItemOwner; + name: string; + description: string; + external_url: string; + html_url: string; + created_at: string; + updated_at: string; + permissions: ReposAddProtectedBranchAppRestrictionsResponseDataItemPermissions; + events: Array; +}; +type ReposAddProtectedBranchAppRestrictionsResponseData = Array< + ReposAddProtectedBranchAppRestrictionsResponseDataItem +>; + type ReposRemoveProtectedBranchAppRestrictionsEndpoint = { /** * owner parameter @@ -5599,12 +18719,51 @@ type ReposRemoveProtectedBranchAppRestrictionsEndpoint = { */ apps: string[]; }; + type ReposRemoveProtectedBranchAppRestrictionsRequestOptions = { method: "DELETE"; - url: Url; + url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/apps"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposRemoveProtectedBranchAppRestrictionsResponseDataItemPermissions = { + metadata: string; + contents: string; + issues: string; + single_file: string; +}; +type ReposRemoveProtectedBranchAppRestrictionsResponseDataItemOwner = { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; +}; +type ReposRemoveProtectedBranchAppRestrictionsResponseDataItem = { + id: number; + slug: string; + node_id: string; + owner: ReposRemoveProtectedBranchAppRestrictionsResponseDataItemOwner; + name: string; + description: string; + external_url: string; + html_url: string; + created_at: string; + updated_at: string; + permissions: ReposRemoveProtectedBranchAppRestrictionsResponseDataItemPermissions; + events: Array; +}; +type ReposRemoveProtectedBranchAppRestrictionsResponseData = Array< + ReposRemoveProtectedBranchAppRestrictionsResponseDataItem +>; + type ReposGetTeamsWithAccessToProtectedBranchEndpoint = { /** * owner parameter @@ -5619,52 +18778,31 @@ type ReposGetTeamsWithAccessToProtectedBranchEndpoint = { */ branch: string; }; + type ReposGetTeamsWithAccessToProtectedBranchRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/teams"; headers: RequestHeaders; request: RequestRequestOptions; }; -type ReposListProtectedBranchTeamRestrictionsEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * branch parameter - */ - branch: string; -}; -type ReposListProtectedBranchTeamRestrictionsRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposListTeamsWithAccessToProtectedBranchEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * branch parameter - */ - branch: string; -}; -type ReposListTeamsWithAccessToProtectedBranchRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; +type ReposGetTeamsWithAccessToProtectedBranchResponseDataItem = { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: null; }; +type ReposGetTeamsWithAccessToProtectedBranchResponseData = Array< + ReposGetTeamsWithAccessToProtectedBranchResponseDataItem +>; + type ReposReplaceProtectedBranchTeamRestrictionsEndpoint = { /** * owner parameter @@ -5683,12 +18821,31 @@ type ReposReplaceProtectedBranchTeamRestrictionsEndpoint = { */ teams: string[]; }; + type ReposReplaceProtectedBranchTeamRestrictionsRequestOptions = { method: "PUT"; - url: Url; + url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/teams"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposReplaceProtectedBranchTeamRestrictionsResponseDataItem = { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: null; +}; +type ReposReplaceProtectedBranchTeamRestrictionsResponseData = Array< + ReposReplaceProtectedBranchTeamRestrictionsResponseDataItem +>; + type ReposAddProtectedBranchTeamRestrictionsEndpoint = { /** * owner parameter @@ -5707,12 +18864,31 @@ type ReposAddProtectedBranchTeamRestrictionsEndpoint = { */ teams: string[]; }; + type ReposAddProtectedBranchTeamRestrictionsRequestOptions = { method: "POST"; - url: Url; + url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/teams"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposAddProtectedBranchTeamRestrictionsResponseDataItem = { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: null; +}; +type ReposAddProtectedBranchTeamRestrictionsResponseData = Array< + ReposAddProtectedBranchTeamRestrictionsResponseDataItem +>; + type ReposRemoveProtectedBranchTeamRestrictionsEndpoint = { /** * owner parameter @@ -5731,12 +18907,31 @@ type ReposRemoveProtectedBranchTeamRestrictionsEndpoint = { */ teams: string[]; }; + type ReposRemoveProtectedBranchTeamRestrictionsRequestOptions = { method: "DELETE"; - url: Url; + url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/teams"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposRemoveProtectedBranchTeamRestrictionsResponseDataItem = { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: null; +}; +type ReposRemoveProtectedBranchTeamRestrictionsResponseData = Array< + ReposRemoveProtectedBranchTeamRestrictionsResponseDataItem +>; + type ReposGetUsersWithAccessToProtectedBranchEndpoint = { /** * owner parameter @@ -5751,52 +18946,37 @@ type ReposGetUsersWithAccessToProtectedBranchEndpoint = { */ branch: string; }; + type ReposGetUsersWithAccessToProtectedBranchRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/users"; headers: RequestHeaders; request: RequestRequestOptions; }; -type ReposListProtectedBranchUserRestrictionsEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * branch parameter - */ - branch: string; -}; -type ReposListProtectedBranchUserRestrictionsRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposListUsersWithAccessToProtectedBranchEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * branch parameter - */ - branch: string; -}; -type ReposListUsersWithAccessToProtectedBranchRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; +type ReposGetUsersWithAccessToProtectedBranchResponseDataItem = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; }; +type ReposGetUsersWithAccessToProtectedBranchResponseData = Array< + ReposGetUsersWithAccessToProtectedBranchResponseDataItem +>; + type ReposReplaceProtectedBranchUserRestrictionsEndpoint = { /** * owner parameter @@ -5815,12 +18995,37 @@ type ReposReplaceProtectedBranchUserRestrictionsEndpoint = { */ users: string[]; }; + type ReposReplaceProtectedBranchUserRestrictionsRequestOptions = { method: "PUT"; - url: Url; + url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/users"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposReplaceProtectedBranchUserRestrictionsResponseDataItem = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposReplaceProtectedBranchUserRestrictionsResponseData = Array< + ReposReplaceProtectedBranchUserRestrictionsResponseDataItem +>; + type ReposAddProtectedBranchUserRestrictionsEndpoint = { /** * owner parameter @@ -5839,12 +19044,37 @@ type ReposAddProtectedBranchUserRestrictionsEndpoint = { */ users: string[]; }; + type ReposAddProtectedBranchUserRestrictionsRequestOptions = { method: "POST"; - url: Url; + url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/users"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposAddProtectedBranchUserRestrictionsResponseDataItem = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposAddProtectedBranchUserRestrictionsResponseData = Array< + ReposAddProtectedBranchUserRestrictionsResponseDataItem +>; + type ReposRemoveProtectedBranchUserRestrictionsEndpoint = { /** * owner parameter @@ -5863,12 +19093,37 @@ type ReposRemoveProtectedBranchUserRestrictionsEndpoint = { */ users: string[]; }; + type ReposRemoveProtectedBranchUserRestrictionsRequestOptions = { method: "DELETE"; - url: Url; + url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/users"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposRemoveProtectedBranchUserRestrictionsResponseDataItem = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposRemoveProtectedBranchUserRestrictionsResponseData = Array< + ReposRemoveProtectedBranchUserRestrictionsResponseDataItem +>; + type ChecksCreateEndpoint = { /** * owner parameter @@ -5887,7 +19142,7 @@ type ChecksCreateEndpoint = { */ head_sha: string; /** - * The URL of the integrator's site that has the full details of the check. + * The URL of the integrator's site that has the full details of the check. If the integrator does not provide this, then the homepage of the GitHub app is used. */ details_url?: string; /** @@ -5904,7 +19159,7 @@ type ChecksCreateEndpoint = { started_at?: string; /** * **Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, or `action_required`. When the conclusion is `action_required`, additional details should be provided on the site specified by `details_url`. - * **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. + * **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. Only GitHub can change a check run conclusion to `stale`. */ conclusion?: | "success" @@ -5925,13 +19180,102 @@ type ChecksCreateEndpoint = { * Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://developer.github.com/v3/activity/events/types/#checkrunevent) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://developer.github.com/v3/checks/runs/#actions-object) description. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://developer.github.com/v3/checks/runs/#check-runs-and-requested-actions)." To learn more about check runs and requested actions, see "[Check runs and requested actions](https://developer.github.com/v3/checks/runs/#check-runs-and-requested-actions)." */ actions?: ChecksCreateParamsActions[]; -}; +} & RequiredPreview<"antiope">; + type ChecksCreateRequestOptions = { method: "POST"; - url: Url; + url: "/repos/:owner/:repo/check-runs"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ChecksCreateResponseDataPullRequestsItemBaseRepo = { + id: number; + url: string; + name: string; +}; +type ChecksCreateResponseDataPullRequestsItemBase = { + ref: string; + sha: string; + repo: ChecksCreateResponseDataPullRequestsItemBaseRepo; +}; +type ChecksCreateResponseDataPullRequestsItemHeadRepo = { + id: number; + url: string; + name: string; +}; +type ChecksCreateResponseDataPullRequestsItemHead = { + ref: string; + sha: string; + repo: ChecksCreateResponseDataPullRequestsItemHeadRepo; +}; +type ChecksCreateResponseDataPullRequestsItem = { + url: string; + id: number; + number: number; + head: ChecksCreateResponseDataPullRequestsItemHead; + base: ChecksCreateResponseDataPullRequestsItemBase; +}; +type ChecksCreateResponseDataAppPermissions = { + metadata: string; + contents: string; + issues: string; + single_file: string; +}; +type ChecksCreateResponseDataAppOwner = { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; +}; +type ChecksCreateResponseDataApp = { + id: number; + slug: string; + node_id: string; + owner: ChecksCreateResponseDataAppOwner; + name: string; + description: string; + external_url: string; + html_url: string; + created_at: string; + updated_at: string; + permissions: ChecksCreateResponseDataAppPermissions; + events: Array; +}; +type ChecksCreateResponseDataCheckSuite = { id: number }; +type ChecksCreateResponseDataOutput = { + title: string; + summary: string; + text: string; + annotations_count?: number; + annotations_url?: string; +}; +type ChecksCreateResponseData = { + id: number; + head_sha: string; + node_id: string; + external_id: string; + url: string; + html_url: string; + details_url: string; + status: string; + conclusion: null | string; + started_at: string; + completed_at: null | string; + output: ChecksCreateResponseDataOutput; + name: string; + check_suite: ChecksCreateResponseDataCheckSuite; + app: ChecksCreateResponseDataApp; + pull_requests: Array; +}; + type ChecksUpdateEndpoint = { /** * owner parameter @@ -5967,7 +19311,7 @@ type ChecksUpdateEndpoint = { status?: "queued" | "in_progress" | "completed"; /** * **Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, or `action_required`. - * **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. + * **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. Only GitHub can change a check run conclusion to `stale`. */ conclusion?: | "success" @@ -5988,13 +19332,102 @@ type ChecksUpdateEndpoint = { * Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://developer.github.com/v3/checks/runs/#actions-object) description. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://developer.github.com/v3/checks/runs/#check-runs-and-requested-actions)." */ actions?: ChecksUpdateParamsActions[]; -}; +} & RequiredPreview<"antiope">; + type ChecksUpdateRequestOptions = { method: "PATCH"; - url: Url; + url: "/repos/:owner/:repo/check-runs/:check_run_id"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ChecksUpdateResponseDataPullRequestsItemBaseRepo = { + id: number; + url: string; + name: string; +}; +type ChecksUpdateResponseDataPullRequestsItemBase = { + ref: string; + sha: string; + repo: ChecksUpdateResponseDataPullRequestsItemBaseRepo; +}; +type ChecksUpdateResponseDataPullRequestsItemHeadRepo = { + id: number; + url: string; + name: string; +}; +type ChecksUpdateResponseDataPullRequestsItemHead = { + ref: string; + sha: string; + repo: ChecksUpdateResponseDataPullRequestsItemHeadRepo; +}; +type ChecksUpdateResponseDataPullRequestsItem = { + url: string; + id: number; + number: number; + head: ChecksUpdateResponseDataPullRequestsItemHead; + base: ChecksUpdateResponseDataPullRequestsItemBase; +}; +type ChecksUpdateResponseDataAppPermissions = { + metadata: string; + contents: string; + issues: string; + single_file: string; +}; +type ChecksUpdateResponseDataAppOwner = { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; +}; +type ChecksUpdateResponseDataApp = { + id: number; + slug: string; + node_id: string; + owner: ChecksUpdateResponseDataAppOwner; + name: string; + description: string; + external_url: string; + html_url: string; + created_at: string; + updated_at: string; + permissions: ChecksUpdateResponseDataAppPermissions; + events: Array; +}; +type ChecksUpdateResponseDataCheckSuite = { id: number }; +type ChecksUpdateResponseDataOutput = { + title: string; + summary: string; + text: string; + annotations_count: number; + annotations_url: string; +}; +type ChecksUpdateResponseData = { + id: number; + head_sha: string; + node_id: string; + external_id: string; + url: string; + html_url: string; + details_url: string; + status: string; + conclusion: string; + started_at: string; + completed_at: string; + output: ChecksUpdateResponseDataOutput; + name: string; + check_suite: ChecksUpdateResponseDataCheckSuite; + app: ChecksUpdateResponseDataApp; + pull_requests: Array; +}; + type ChecksGetEndpoint = { /** * owner parameter @@ -6008,13 +19441,102 @@ type ChecksGetEndpoint = { * check_run_id parameter */ check_run_id: number; -}; +} & RequiredPreview<"antiope">; + type ChecksGetRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/check-runs/:check_run_id"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ChecksGetResponseDataPullRequestsItemBaseRepo = { + id: number; + url: string; + name: string; +}; +type ChecksGetResponseDataPullRequestsItemBase = { + ref: string; + sha: string; + repo: ChecksGetResponseDataPullRequestsItemBaseRepo; +}; +type ChecksGetResponseDataPullRequestsItemHeadRepo = { + id: number; + url: string; + name: string; +}; +type ChecksGetResponseDataPullRequestsItemHead = { + ref: string; + sha: string; + repo: ChecksGetResponseDataPullRequestsItemHeadRepo; +}; +type ChecksGetResponseDataPullRequestsItem = { + url: string; + id: number; + number: number; + head: ChecksGetResponseDataPullRequestsItemHead; + base: ChecksGetResponseDataPullRequestsItemBase; +}; +type ChecksGetResponseDataAppPermissions = { + metadata: string; + contents: string; + issues: string; + single_file: string; +}; +type ChecksGetResponseDataAppOwner = { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; +}; +type ChecksGetResponseDataApp = { + id: number; + slug: string; + node_id: string; + owner: ChecksGetResponseDataAppOwner; + name: string; + description: string; + external_url: string; + html_url: string; + created_at: string; + updated_at: string; + permissions: ChecksGetResponseDataAppPermissions; + events: Array; +}; +type ChecksGetResponseDataCheckSuite = { id: number }; +type ChecksGetResponseDataOutput = { + title: string; + summary: string; + text: string; + annotations_count: number; + annotations_url: string; +}; +type ChecksGetResponseData = { + id: number; + head_sha: string; + node_id: string; + external_id: string; + url: string; + html_url: string; + details_url: string; + status: string; + conclusion: string; + started_at: string; + completed_at: string; + output: ChecksGetResponseDataOutput; + name: string; + check_suite: ChecksGetResponseDataCheckSuite; + app: ChecksGetResponseDataApp; + pull_requests: Array; +}; + type ChecksListAnnotationsEndpoint = { /** * owner parameter @@ -6036,13 +19558,29 @@ type ChecksListAnnotationsEndpoint = { * Page number of the results to fetch. */ page?: number; -}; +} & RequiredPreview<"antiope">; + type ChecksListAnnotationsRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/check-runs/:check_run_id/annotations"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ChecksListAnnotationsResponseDataItem = { + path: string; + start_line: number; + end_line: number; + start_column: number; + end_column: number; + annotation_level: string; + title: string; + message: string; + raw_details: string; +}; +type ChecksListAnnotationsResponseData = Array< + ChecksListAnnotationsResponseDataItem +>; + type ChecksCreateSuiteEndpoint = { /** * owner parameter @@ -6056,13 +19594,170 @@ type ChecksCreateSuiteEndpoint = { * The sha of the head commit. */ head_sha: string; -}; +} & RequiredPreview<"antiope">; + type ChecksCreateSuiteRequestOptions = { method: "POST"; - url: Url; + url: "/repos/:owner/:repo/check-suites"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ChecksCreateSuiteResponseDataRepositoryPermissions = { + admin: boolean; + push: boolean; + pull: boolean; +}; +type ChecksCreateSuiteResponseDataRepositoryOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ChecksCreateSuiteResponseDataRepository = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: ChecksCreateSuiteResponseDataRepositoryOwner; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: null; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: Array; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: ChecksCreateSuiteResponseDataRepositoryPermissions; + allow_rebase_merge: boolean; + template_repository: null; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; +}; +type ChecksCreateSuiteResponseDataAppPermissions = { + metadata: string; + contents: string; + issues: string; + single_file: string; +}; +type ChecksCreateSuiteResponseDataAppOwner = { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; +}; +type ChecksCreateSuiteResponseDataApp = { + id: number; + slug: string; + node_id: string; + owner: ChecksCreateSuiteResponseDataAppOwner; + name: string; + description: string; + external_url: string; + html_url: string; + created_at: string; + updated_at: string; + permissions: ChecksCreateSuiteResponseDataAppPermissions; + events: Array; +}; +type ChecksCreateSuiteResponseData = { + id: number; + node_id: string; + head_branch: string; + head_sha: string; + status: string; + conclusion: string; + url: string; + before: string; + after: string; + pull_requests: Array; + app: ChecksCreateSuiteResponseDataApp; + repository: ChecksCreateSuiteResponseDataRepository; +}; + type ChecksSetSuitesPreferencesEndpoint = { /** * owner parameter @@ -6076,13 +19771,135 @@ type ChecksSetSuitesPreferencesEndpoint = { * Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the [`auto_trigger_checks` object](https://developer.github.com/v3/checks/suites/#auto_trigger_checks-object) description for details. */ auto_trigger_checks?: ChecksSetSuitesPreferencesParamsAutoTriggerChecks[]; -}; +} & RequiredPreview<"antiope">; + type ChecksSetSuitesPreferencesRequestOptions = { method: "PATCH"; - url: Url; + url: "/repos/:owner/:repo/check-suites/preferences"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ChecksSetSuitesPreferencesResponseDataRepositoryPermissions = { + admin: boolean; + push: boolean; + pull: boolean; +}; +type ChecksSetSuitesPreferencesResponseDataRepositoryOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ChecksSetSuitesPreferencesResponseDataRepository = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: ChecksSetSuitesPreferencesResponseDataRepositoryOwner; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: null; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: Array; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: ChecksSetSuitesPreferencesResponseDataRepositoryPermissions; + allow_rebase_merge: boolean; + template_repository: null; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; +}; +type ChecksSetSuitesPreferencesResponseDataPreferencesAutoTriggerChecksItem = { + app_id: number; + setting: boolean; +}; +type ChecksSetSuitesPreferencesResponseDataPreferences = { + auto_trigger_checks: Array< + ChecksSetSuitesPreferencesResponseDataPreferencesAutoTriggerChecksItem + >; +}; +type ChecksSetSuitesPreferencesResponseData = { + preferences: ChecksSetSuitesPreferencesResponseDataPreferences; + repository: ChecksSetSuitesPreferencesResponseDataRepository; +}; + type ChecksGetSuiteEndpoint = { /** * owner parameter @@ -6096,13 +19913,170 @@ type ChecksGetSuiteEndpoint = { * check_suite_id parameter */ check_suite_id: number; -}; +} & RequiredPreview<"antiope">; + type ChecksGetSuiteRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/check-suites/:check_suite_id"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ChecksGetSuiteResponseDataRepositoryPermissions = { + admin: boolean; + push: boolean; + pull: boolean; +}; +type ChecksGetSuiteResponseDataRepositoryOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ChecksGetSuiteResponseDataRepository = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: ChecksGetSuiteResponseDataRepositoryOwner; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: null; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: Array; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: ChecksGetSuiteResponseDataRepositoryPermissions; + allow_rebase_merge: boolean; + template_repository: null; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; +}; +type ChecksGetSuiteResponseDataAppPermissions = { + metadata: string; + contents: string; + issues: string; + single_file: string; +}; +type ChecksGetSuiteResponseDataAppOwner = { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; +}; +type ChecksGetSuiteResponseDataApp = { + id: number; + slug: string; + node_id: string; + owner: ChecksGetSuiteResponseDataAppOwner; + name: string; + description: string; + external_url: string; + html_url: string; + created_at: string; + updated_at: string; + permissions: ChecksGetSuiteResponseDataAppPermissions; + events: Array; +}; +type ChecksGetSuiteResponseData = { + id: number; + node_id: string; + head_branch: string; + head_sha: string; + status: string; + conclusion: string; + url: string; + before: string; + after: string; + pull_requests: Array; + app: ChecksGetSuiteResponseDataApp; + repository: ChecksGetSuiteResponseDataRepository; +}; + type ChecksListForSuiteEndpoint = { /** * owner parameter @@ -6136,13 +20110,108 @@ type ChecksListForSuiteEndpoint = { * Page number of the results to fetch. */ page?: number; -}; +} & RequiredPreview<"antiope">; + type ChecksListForSuiteRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/check-suites/:check_suite_id/check-runs"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ChecksListForSuiteResponseDataCheckRunsItemPullRequestsItemBaseRepo = { + id: number; + url: string; + name: string; +}; +type ChecksListForSuiteResponseDataCheckRunsItemPullRequestsItemBase = { + ref: string; + sha: string; + repo: ChecksListForSuiteResponseDataCheckRunsItemPullRequestsItemBaseRepo; +}; +type ChecksListForSuiteResponseDataCheckRunsItemPullRequestsItemHeadRepo = { + id: number; + url: string; + name: string; +}; +type ChecksListForSuiteResponseDataCheckRunsItemPullRequestsItemHead = { + ref: string; + sha: string; + repo: ChecksListForSuiteResponseDataCheckRunsItemPullRequestsItemHeadRepo; +}; +type ChecksListForSuiteResponseDataCheckRunsItemPullRequestsItem = { + url: string; + id: number; + number: number; + head: ChecksListForSuiteResponseDataCheckRunsItemPullRequestsItemHead; + base: ChecksListForSuiteResponseDataCheckRunsItemPullRequestsItemBase; +}; +type ChecksListForSuiteResponseDataCheckRunsItemAppPermissions = { + metadata: string; + contents: string; + issues: string; + single_file: string; +}; +type ChecksListForSuiteResponseDataCheckRunsItemAppOwner = { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; +}; +type ChecksListForSuiteResponseDataCheckRunsItemApp = { + id: number; + slug: string; + node_id: string; + owner: ChecksListForSuiteResponseDataCheckRunsItemAppOwner; + name: string; + description: string; + external_url: string; + html_url: string; + created_at: string; + updated_at: string; + permissions: ChecksListForSuiteResponseDataCheckRunsItemAppPermissions; + events: Array; +}; +type ChecksListForSuiteResponseDataCheckRunsItemCheckSuite = { id: number }; +type ChecksListForSuiteResponseDataCheckRunsItemOutput = { + title: string; + summary: string; + text: string; + annotations_count: number; + annotations_url: string; +}; +type ChecksListForSuiteResponseDataCheckRunsItem = { + id: number; + head_sha: string; + node_id: string; + external_id: string; + url: string; + html_url: string; + details_url: string; + status: string; + conclusion: string; + started_at: string; + completed_at: string; + output: ChecksListForSuiteResponseDataCheckRunsItemOutput; + name: string; + check_suite: ChecksListForSuiteResponseDataCheckRunsItemCheckSuite; + app: ChecksListForSuiteResponseDataCheckRunsItemApp; + pull_requests: Array< + ChecksListForSuiteResponseDataCheckRunsItemPullRequestsItem + >; +}; +type ChecksListForSuiteResponseData = { + total_count: number; + check_runs: Array; +}; + type ChecksRerequestSuiteEndpoint = { /** * owner parameter @@ -6156,13 +20225,86 @@ type ChecksRerequestSuiteEndpoint = { * check_suite_id parameter */ check_suite_id: number; -}; +} & RequiredPreview<"antiope">; + type ChecksRerequestSuiteRequestOptions = { method: "POST"; - url: Url; + url: "/repos/:owner/:repo/check-suites/:check_suite_id/rerequest"; headers: RequestHeaders; request: RequestRequestOptions; }; + +type CodeScanningListAlertsForRepoEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Set to `closed` to list only closed code scanning alerts. + */ + state?: string; +}; + +type CodeScanningListAlertsForRepoRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/code-scanning/alerts"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type CodeScanningListAlertsForRepoResponseDataItem = { + rule_id: string; + rule_severity: string; + rule_description: string; + tool: string; + created_at: string; + open: boolean; + closed_by: null; + closed_at: null; + url: string; + html_url: string; +}; +type CodeScanningListAlertsForRepoResponseData = Array< + CodeScanningListAlertsForRepoResponseDataItem +>; + +type CodeScanningGetAlertEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * alert_id parameter + */ + alert_id: number; +}; + +type CodeScanningGetAlertRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/code-scanning/alerts/:alert_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type CodeScanningGetAlertResponseData = { + rule_id: string; + rule_severity: string; + rule_description: string; + tool: string; + created_at: string; + open: boolean; + closed_by: null; + closed_at: null; + url: string; + html_url: string; +}; + type ReposListCollaboratorsEndpoint = { /** * owner parameter @@ -6188,12 +20330,43 @@ type ReposListCollaboratorsEndpoint = { */ page?: number; }; + type ReposListCollaboratorsRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/collaborators"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposListCollaboratorsResponseDataItemPermissions = { + pull: boolean; + push: boolean; + admin: boolean; +}; +type ReposListCollaboratorsResponseDataItem = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + permissions: ReposListCollaboratorsResponseDataItemPermissions; +}; +type ReposListCollaboratorsResponseData = Array< + ReposListCollaboratorsResponseDataItem +>; + type ReposCheckCollaboratorEndpoint = { /** * owner parameter @@ -6208,12 +20381,14 @@ type ReposCheckCollaboratorEndpoint = { */ username: string; }; + type ReposCheckCollaboratorRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/collaborators/:username"; headers: RequestHeaders; request: RequestRequestOptions; }; + type ReposAddCollaboratorEndpoint = { /** * owner parameter @@ -6232,15 +20407,138 @@ type ReposAddCollaboratorEndpoint = { * \* `pull` - can pull, but not push to or administer this repository. * \* `push` - can pull and push, but not administer this repository. * \* `admin` - can pull, push and administer this repository. + * \* `maintain` - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions. + * \* `triage` - Recommended for contributors who need to proactively manage issues and pull requests without write access. */ - permission?: "pull" | "push" | "admin"; + permission?: "pull" | "push" | "admin" | "maintain" | "triage"; }; + type ReposAddCollaboratorRequestOptions = { method: "PUT"; - url: Url; + url: "/repos/:owner/:repo/collaborators/:username"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposAddCollaboratorResponseDataInviter = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposAddCollaboratorResponseDataInvitee = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposAddCollaboratorResponseDataRepositoryOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposAddCollaboratorResponseDataRepository = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: ReposAddCollaboratorResponseDataRepositoryOwner; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; +}; +type ReposAddCollaboratorResponseData = { + id: number; + repository: ReposAddCollaboratorResponseDataRepository; + invitee: ReposAddCollaboratorResponseDataInvitee; + inviter: ReposAddCollaboratorResponseDataInviter; + permissions: string; + created_at: string; + url: string; + html_url: string; +}; + type ReposRemoveCollaboratorEndpoint = { /** * owner parameter @@ -6255,12 +20553,14 @@ type ReposRemoveCollaboratorEndpoint = { */ username: string; }; + type ReposRemoveCollaboratorRequestOptions = { method: "DELETE"; - url: Url; + url: "/repos/:owner/:repo/collaborators/:username"; headers: RequestHeaders; request: RequestRequestOptions; }; + type ReposGetCollaboratorPermissionLevelEndpoint = { /** * owner parameter @@ -6275,12 +20575,38 @@ type ReposGetCollaboratorPermissionLevelEndpoint = { */ username: string; }; + type ReposGetCollaboratorPermissionLevelRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/collaborators/:username/permission"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposGetCollaboratorPermissionLevelResponseDataUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposGetCollaboratorPermissionLevelResponseData = { + permission: string; + user: ReposGetCollaboratorPermissionLevelResponseDataUser; +}; + type ReposListCommitCommentsEndpoint = { /** * owner parameter @@ -6299,12 +20625,51 @@ type ReposListCommitCommentsEndpoint = { */ page?: number; }; + type ReposListCommitCommentsRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/comments"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposListCommitCommentsResponseDataItemUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposListCommitCommentsResponseDataItem = { + html_url: string; + url: string; + id: number; + node_id: string; + body: string; + path: string; + position: number; + line: number; + commit_id: string; + user: ReposListCommitCommentsResponseDataItemUser; + created_at: string; + updated_at: string; +}; +type ReposListCommitCommentsResponseData = Array< + ReposListCommitCommentsResponseDataItem +>; + type ReposGetCommitCommentEndpoint = { /** * owner parameter @@ -6319,12 +20684,48 @@ type ReposGetCommitCommentEndpoint = { */ comment_id: number; }; + type ReposGetCommitCommentRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/comments/:comment_id"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposGetCommitCommentResponseDataUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposGetCommitCommentResponseData = { + html_url: string; + url: string; + id: number; + node_id: string; + body: string; + path: string; + position: number; + line: number; + commit_id: string; + user: ReposGetCommitCommentResponseDataUser; + created_at: string; + updated_at: string; +}; + type ReposUpdateCommitCommentEndpoint = { /** * owner parameter @@ -6343,12 +20744,48 @@ type ReposUpdateCommitCommentEndpoint = { */ body: string; }; + type ReposUpdateCommitCommentRequestOptions = { method: "PATCH"; - url: Url; + url: "/repos/:owner/:repo/comments/:comment_id"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposUpdateCommitCommentResponseDataUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposUpdateCommitCommentResponseData = { + html_url: string; + url: string; + id: number; + node_id: string; + body: string; + path: string; + position: number; + line: number; + commit_id: string; + user: ReposUpdateCommitCommentResponseDataUser; + created_at: string; + updated_at: string; +}; + type ReposDeleteCommitCommentEndpoint = { /** * owner parameter @@ -6363,12 +20800,14 @@ type ReposDeleteCommitCommentEndpoint = { */ comment_id: number; }; + type ReposDeleteCommitCommentRequestOptions = { method: "DELETE"; - url: Url; + url: "/repos/:owner/:repo/comments/:comment_id"; headers: RequestHeaders; request: RequestRequestOptions; }; + type ReactionsListForCommitCommentEndpoint = { /** * owner parameter @@ -6402,13 +20841,45 @@ type ReactionsListForCommitCommentEndpoint = { * Page number of the results to fetch. */ page?: number; -}; +} & RequiredPreview<"squirrel-girl">; + type ReactionsListForCommitCommentRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/comments/:comment_id/reactions"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReactionsListForCommitCommentResponseDataItemUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReactionsListForCommitCommentResponseDataItem = { + id: number; + node_id: string; + user: ReactionsListForCommitCommentResponseDataItemUser; + content: string; + created_at: string; +}; +type ReactionsListForCommitCommentResponseData = Array< + ReactionsListForCommitCommentResponseDataItem +>; + type ReactionsCreateForCommitCommentEndpoint = { /** * owner parameter @@ -6434,13 +20905,68 @@ type ReactionsCreateForCommitCommentEndpoint = { | "hooray" | "rocket" | "eyes"; -}; +} & RequiredPreview<"squirrel-girl">; + type ReactionsCreateForCommitCommentRequestOptions = { method: "POST"; - url: Url; + url: "/repos/:owner/:repo/comments/:comment_id/reactions"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReactionsCreateForCommitCommentResponseDataUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReactionsCreateForCommitCommentResponseData = { + id: number; + node_id: string; + user: ReactionsCreateForCommitCommentResponseDataUser; + content: string; + created_at: string; +}; + +type ReactionsDeleteForCommitCommentEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * comment_id parameter + */ + comment_id: number; + /** + * reaction_id parameter + */ + reaction_id: number; +} & RequiredPreview<"squirrel-girl">; + +type ReactionsDeleteForCommitCommentRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/comments/:comment_id/reactions/:reaction_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; + type ReposListCommitsEndpoint = { /** * owner parameter @@ -6479,12 +21005,93 @@ type ReposListCommitsEndpoint = { */ page?: number; }; + type ReposListCommitsRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/commits"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposListCommitsResponseDataItemParentsItem = { url: string; sha: string }; +type ReposListCommitsResponseDataItemCommitter = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposListCommitsResponseDataItemAuthor = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposListCommitsResponseDataItemCommitVerification = { + verified: boolean; + reason: string; + signature: null; + payload: null; +}; +type ReposListCommitsResponseDataItemCommitTree = { url: string; sha: string }; +type ReposListCommitsResponseDataItemCommitCommitter = { + name: string; + email: string; + date: string; +}; +type ReposListCommitsResponseDataItemCommitAuthor = { + name: string; + email: string; + date: string; +}; +type ReposListCommitsResponseDataItemCommit = { + url: string; + author: ReposListCommitsResponseDataItemCommitAuthor; + committer: ReposListCommitsResponseDataItemCommitCommitter; + message: string; + tree: ReposListCommitsResponseDataItemCommitTree; + comment_count: number; + verification: ReposListCommitsResponseDataItemCommitVerification; +}; +type ReposListCommitsResponseDataItem = { + url: string; + sha: string; + node_id: string; + html_url: string; + comments_url: string; + commit: ReposListCommitsResponseDataItemCommit; + author: ReposListCommitsResponseDataItemAuthor; + committer: ReposListCommitsResponseDataItemCommitter; + parents: Array; +}; +type ReposListCommitsResponseData = Array; + type ReposListBranchesForHeadCommitEndpoint = { /** * owner parameter @@ -6498,13 +21105,27 @@ type ReposListBranchesForHeadCommitEndpoint = { * commit_sha parameter */ commit_sha: string; -}; +} & RequiredPreview<"groot">; + type ReposListBranchesForHeadCommitRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/commits/:commit_sha/branches-where-head"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposListBranchesForHeadCommitResponseDataItemCommit = { + sha: string; + url: string; +}; +type ReposListBranchesForHeadCommitResponseDataItem = { + name: string; + commit: ReposListBranchesForHeadCommitResponseDataItemCommit; + protected: boolean; +}; +type ReposListBranchesForHeadCommitResponseData = Array< + ReposListBranchesForHeadCommitResponseDataItem +>; + type ReposListCommentsForCommitEndpoint = { /** * owner parameter @@ -6527,12 +21148,51 @@ type ReposListCommentsForCommitEndpoint = { */ page?: number; }; + type ReposListCommentsForCommitRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/commits/:commit_sha/comments"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposListCommentsForCommitResponseDataItemUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposListCommentsForCommitResponseDataItem = { + html_url: string; + url: string; + id: number; + node_id: string; + body: string; + path: string; + position: number; + line: number; + commit_id: string; + user: ReposListCommentsForCommitResponseDataItemUser; + created_at: string; + updated_at: string; +}; +type ReposListCommentsForCommitResponseData = Array< + ReposListCommentsForCommitResponseDataItem +>; + type ReposCreateCommitCommentEndpoint = { /** * owner parameter @@ -6563,12 +21223,48 @@ type ReposCreateCommitCommentEndpoint = { */ line?: number; }; + type ReposCreateCommitCommentRequestOptions = { method: "POST"; - url: Url; + url: "/repos/:owner/:repo/commits/:commit_sha/comments"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposCreateCommitCommentResponseDataUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposCreateCommitCommentResponseData = { + html_url: string; + url: string; + id: number; + node_id: string; + body: string; + path: string; + position: number; + line: number; + commit_id: string; + user: ReposCreateCommitCommentResponseDataUser; + created_at: string; + updated_at: string; +}; + type ReposListPullRequestsAssociatedWithCommitEndpoint = { /** * owner parameter @@ -6590,13 +21286,506 @@ type ReposListPullRequestsAssociatedWithCommitEndpoint = { * Page number of the results to fetch. */ page?: number; -}; +} & RequiredPreview<"groot">; + type ReposListPullRequestsAssociatedWithCommitRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/commits/:commit_sha/pulls"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposListPullRequestsAssociatedWithCommitResponseDataItemLinksStatuses = { + href: string; +}; +type ReposListPullRequestsAssociatedWithCommitResponseDataItemLinksCommits = { + href: string; +}; +type ReposListPullRequestsAssociatedWithCommitResponseDataItemLinksReviewComment = { + href: string; +}; +type ReposListPullRequestsAssociatedWithCommitResponseDataItemLinksReviewComments = { + href: string; +}; +type ReposListPullRequestsAssociatedWithCommitResponseDataItemLinksComments = { + href: string; +}; +type ReposListPullRequestsAssociatedWithCommitResponseDataItemLinksIssue = { + href: string; +}; +type ReposListPullRequestsAssociatedWithCommitResponseDataItemLinksHtml = { + href: string; +}; +type ReposListPullRequestsAssociatedWithCommitResponseDataItemLinksSelf = { + href: string; +}; +type ReposListPullRequestsAssociatedWithCommitResponseDataItemLinks = { + self: ReposListPullRequestsAssociatedWithCommitResponseDataItemLinksSelf; + html: ReposListPullRequestsAssociatedWithCommitResponseDataItemLinksHtml; + issue: ReposListPullRequestsAssociatedWithCommitResponseDataItemLinksIssue; + comments: ReposListPullRequestsAssociatedWithCommitResponseDataItemLinksComments; + review_comments: ReposListPullRequestsAssociatedWithCommitResponseDataItemLinksReviewComments; + review_comment: ReposListPullRequestsAssociatedWithCommitResponseDataItemLinksReviewComment; + commits: ReposListPullRequestsAssociatedWithCommitResponseDataItemLinksCommits; + statuses: ReposListPullRequestsAssociatedWithCommitResponseDataItemLinksStatuses; +}; +type ReposListPullRequestsAssociatedWithCommitResponseDataItemBaseRepoPermissions = { + admin: boolean; + push: boolean; + pull: boolean; +}; +type ReposListPullRequestsAssociatedWithCommitResponseDataItemBaseRepoOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposListPullRequestsAssociatedWithCommitResponseDataItemBaseRepo = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: ReposListPullRequestsAssociatedWithCommitResponseDataItemBaseRepoOwner; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: null; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: Array; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: ReposListPullRequestsAssociatedWithCommitResponseDataItemBaseRepoPermissions; + allow_rebase_merge: boolean; + template_repository: null; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; +}; +type ReposListPullRequestsAssociatedWithCommitResponseDataItemBaseUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposListPullRequestsAssociatedWithCommitResponseDataItemBase = { + label: string; + ref: string; + sha: string; + user: ReposListPullRequestsAssociatedWithCommitResponseDataItemBaseUser; + repo: ReposListPullRequestsAssociatedWithCommitResponseDataItemBaseRepo; +}; +type ReposListPullRequestsAssociatedWithCommitResponseDataItemHeadRepoPermissions = { + admin: boolean; + push: boolean; + pull: boolean; +}; +type ReposListPullRequestsAssociatedWithCommitResponseDataItemHeadRepoOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposListPullRequestsAssociatedWithCommitResponseDataItemHeadRepo = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: ReposListPullRequestsAssociatedWithCommitResponseDataItemHeadRepoOwner; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: null; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: Array; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: ReposListPullRequestsAssociatedWithCommitResponseDataItemHeadRepoPermissions; + allow_rebase_merge: boolean; + template_repository: null; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; +}; +type ReposListPullRequestsAssociatedWithCommitResponseDataItemHeadUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposListPullRequestsAssociatedWithCommitResponseDataItemHead = { + label: string; + ref: string; + sha: string; + user: ReposListPullRequestsAssociatedWithCommitResponseDataItemHeadUser; + repo: ReposListPullRequestsAssociatedWithCommitResponseDataItemHeadRepo; +}; +type ReposListPullRequestsAssociatedWithCommitResponseDataItemRequestedTeamsItem = { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: null; +}; +type ReposListPullRequestsAssociatedWithCommitResponseDataItemRequestedReviewersItem = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposListPullRequestsAssociatedWithCommitResponseDataItemAssigneesItem = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposListPullRequestsAssociatedWithCommitResponseDataItemAssignee = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposListPullRequestsAssociatedWithCommitResponseDataItemMilestoneCreator = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposListPullRequestsAssociatedWithCommitResponseDataItemMilestone = { + url: string; + html_url: string; + labels_url: string; + id: number; + node_id: string; + number: number; + state: string; + title: string; + description: string; + creator: ReposListPullRequestsAssociatedWithCommitResponseDataItemMilestoneCreator; + open_issues: number; + closed_issues: number; + created_at: string; + updated_at: string; + closed_at: string; + due_on: string; +}; +type ReposListPullRequestsAssociatedWithCommitResponseDataItemLabelsItem = { + id: number; + node_id: string; + url: string; + name: string; + description: string; + color: string; + default: boolean; +}; +type ReposListPullRequestsAssociatedWithCommitResponseDataItemUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposListPullRequestsAssociatedWithCommitResponseDataItem = { + url: string; + id: number; + node_id: string; + html_url: string; + diff_url: string; + patch_url: string; + issue_url: string; + commits_url: string; + review_comments_url: string; + review_comment_url: string; + comments_url: string; + statuses_url: string; + number: number; + state: string; + locked: boolean; + title: string; + user: ReposListPullRequestsAssociatedWithCommitResponseDataItemUser; + body: string; + labels: Array< + ReposListPullRequestsAssociatedWithCommitResponseDataItemLabelsItem + >; + milestone: ReposListPullRequestsAssociatedWithCommitResponseDataItemMilestone; + active_lock_reason: string; + created_at: string; + updated_at: string; + closed_at: string; + merged_at: string; + merge_commit_sha: string; + assignee: ReposListPullRequestsAssociatedWithCommitResponseDataItemAssignee; + assignees: Array< + ReposListPullRequestsAssociatedWithCommitResponseDataItemAssigneesItem + >; + requested_reviewers: Array< + ReposListPullRequestsAssociatedWithCommitResponseDataItemRequestedReviewersItem + >; + requested_teams: Array< + ReposListPullRequestsAssociatedWithCommitResponseDataItemRequestedTeamsItem + >; + head: ReposListPullRequestsAssociatedWithCommitResponseDataItemHead; + base: ReposListPullRequestsAssociatedWithCommitResponseDataItemBase; + _links: ReposListPullRequestsAssociatedWithCommitResponseDataItemLinks; + author_association: string; + draft: boolean; +}; +type ReposListPullRequestsAssociatedWithCommitResponseData = Array< + ReposListPullRequestsAssociatedWithCommitResponseDataItem +>; + type ReposGetCommitEndpoint = { /** * owner parameter @@ -6611,12 +21800,109 @@ type ReposGetCommitEndpoint = { */ ref: string; }; + type ReposGetCommitRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/commits/:ref"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposGetCommitResponseDataFilesItem = { + filename: string; + additions: number; + deletions: number; + changes: number; + status: string; + raw_url: string; + blob_url: string; + patch: string; +}; +type ReposGetCommitResponseDataStats = { + additions: number; + deletions: number; + total: number; +}; +type ReposGetCommitResponseDataParentsItem = { url: string; sha: string }; +type ReposGetCommitResponseDataCommitter = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposGetCommitResponseDataAuthor = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposGetCommitResponseDataCommitVerification = { + verified: boolean; + reason: string; + signature: null; + payload: null; +}; +type ReposGetCommitResponseDataCommitTree = { url: string; sha: string }; +type ReposGetCommitResponseDataCommitCommitter = { + name: string; + email: string; + date: string; +}; +type ReposGetCommitResponseDataCommitAuthor = { + name: string; + email: string; + date: string; +}; +type ReposGetCommitResponseDataCommit = { + url: string; + author: ReposGetCommitResponseDataCommitAuthor; + committer: ReposGetCommitResponseDataCommitCommitter; + message: string; + tree: ReposGetCommitResponseDataCommitTree; + comment_count: number; + verification: ReposGetCommitResponseDataCommitVerification; +}; +type ReposGetCommitResponseData = { + url: string; + sha: string; + node_id: string; + html_url: string; + comments_url: string; + commit: ReposGetCommitResponseDataCommit; + author: ReposGetCommitResponseDataAuthor; + committer: ReposGetCommitResponseDataCommitter; + parents: Array; + stats: ReposGetCommitResponseDataStats; + files: Array; +}; + type ChecksListForRefEndpoint = { /** * owner parameter @@ -6650,13 +21936,108 @@ type ChecksListForRefEndpoint = { * Page number of the results to fetch. */ page?: number; -}; +} & RequiredPreview<"antiope">; + type ChecksListForRefRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/commits/:ref/check-runs"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ChecksListForRefResponseDataCheckRunsItemPullRequestsItemBaseRepo = { + id: number; + url: string; + name: string; +}; +type ChecksListForRefResponseDataCheckRunsItemPullRequestsItemBase = { + ref: string; + sha: string; + repo: ChecksListForRefResponseDataCheckRunsItemPullRequestsItemBaseRepo; +}; +type ChecksListForRefResponseDataCheckRunsItemPullRequestsItemHeadRepo = { + id: number; + url: string; + name: string; +}; +type ChecksListForRefResponseDataCheckRunsItemPullRequestsItemHead = { + ref: string; + sha: string; + repo: ChecksListForRefResponseDataCheckRunsItemPullRequestsItemHeadRepo; +}; +type ChecksListForRefResponseDataCheckRunsItemPullRequestsItem = { + url: string; + id: number; + number: number; + head: ChecksListForRefResponseDataCheckRunsItemPullRequestsItemHead; + base: ChecksListForRefResponseDataCheckRunsItemPullRequestsItemBase; +}; +type ChecksListForRefResponseDataCheckRunsItemAppPermissions = { + metadata: string; + contents: string; + issues: string; + single_file: string; +}; +type ChecksListForRefResponseDataCheckRunsItemAppOwner = { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; +}; +type ChecksListForRefResponseDataCheckRunsItemApp = { + id: number; + slug: string; + node_id: string; + owner: ChecksListForRefResponseDataCheckRunsItemAppOwner; + name: string; + description: string; + external_url: string; + html_url: string; + created_at: string; + updated_at: string; + permissions: ChecksListForRefResponseDataCheckRunsItemAppPermissions; + events: Array; +}; +type ChecksListForRefResponseDataCheckRunsItemCheckSuite = { id: number }; +type ChecksListForRefResponseDataCheckRunsItemOutput = { + title: string; + summary: string; + text: string; + annotations_count: number; + annotations_url: string; +}; +type ChecksListForRefResponseDataCheckRunsItem = { + id: number; + head_sha: string; + node_id: string; + external_id: string; + url: string; + html_url: string; + details_url: string; + status: string; + conclusion: string; + started_at: string; + completed_at: string; + output: ChecksListForRefResponseDataCheckRunsItemOutput; + name: string; + check_suite: ChecksListForRefResponseDataCheckRunsItemCheckSuite; + app: ChecksListForRefResponseDataCheckRunsItemApp; + pull_requests: Array< + ChecksListForRefResponseDataCheckRunsItemPullRequestsItem + >; +}; +type ChecksListForRefResponseData = { + total_count: number; + check_runs: Array; +}; + type ChecksListSuitesForRefEndpoint = { /** * owner parameter @@ -6686,13 +22067,174 @@ type ChecksListSuitesForRefEndpoint = { * Page number of the results to fetch. */ page?: number; -}; +} & RequiredPreview<"antiope">; + type ChecksListSuitesForRefRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/commits/:ref/check-suites"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ChecksListSuitesForRefResponseDataCheckSuitesItemRepositoryPermissions = { + admin: boolean; + push: boolean; + pull: boolean; +}; +type ChecksListSuitesForRefResponseDataCheckSuitesItemRepositoryOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ChecksListSuitesForRefResponseDataCheckSuitesItemRepository = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: ChecksListSuitesForRefResponseDataCheckSuitesItemRepositoryOwner; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: null; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: Array; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: ChecksListSuitesForRefResponseDataCheckSuitesItemRepositoryPermissions; + allow_rebase_merge: boolean; + template_repository: null; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; +}; +type ChecksListSuitesForRefResponseDataCheckSuitesItemAppPermissions = { + metadata: string; + contents: string; + issues: string; + single_file: string; +}; +type ChecksListSuitesForRefResponseDataCheckSuitesItemAppOwner = { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; +}; +type ChecksListSuitesForRefResponseDataCheckSuitesItemApp = { + id: number; + slug: string; + node_id: string; + owner: ChecksListSuitesForRefResponseDataCheckSuitesItemAppOwner; + name: string; + description: string; + external_url: string; + html_url: string; + created_at: string; + updated_at: string; + permissions: ChecksListSuitesForRefResponseDataCheckSuitesItemAppPermissions; + events: Array; +}; +type ChecksListSuitesForRefResponseDataCheckSuitesItem = { + id: number; + node_id: string; + head_branch: string; + head_sha: string; + status: string; + conclusion: string; + url: string; + before: string; + after: string; + pull_requests: Array; + app: ChecksListSuitesForRefResponseDataCheckSuitesItemApp; + repository: ChecksListSuitesForRefResponseDataCheckSuitesItemRepository; +}; +type ChecksListSuitesForRefResponseData = { + total_count: number; + check_suites: Array; +}; + type ReposGetCombinedStatusForRefEndpoint = { /** * owner parameter @@ -6707,12 +22249,104 @@ type ReposGetCombinedStatusForRefEndpoint = { */ ref: string; }; + type ReposGetCombinedStatusForRefRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/commits/:ref/status"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposGetCombinedStatusForRefResponseDataRepositoryOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposGetCombinedStatusForRefResponseDataRepository = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: ReposGetCombinedStatusForRefResponseDataRepositoryOwner; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; +}; +type ReposGetCombinedStatusForRefResponseDataStatusesItem = { + url: string; + avatar_url: string; + id: number; + node_id: string; + state: string; + description: string; + target_url: string; + context: string; + created_at: string; + updated_at: string; +}; +type ReposGetCombinedStatusForRefResponseData = { + state: string; + statuses: Array; + sha: string; + total_count: number; + repository: ReposGetCombinedStatusForRefResponseDataRepository; + commit_url: string; + url: string; +}; + type ReposListStatusesForRefEndpoint = { /** * owner parameter @@ -6735,12 +22369,50 @@ type ReposListStatusesForRefEndpoint = { */ page?: number; }; + type ReposListStatusesForRefRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/commits/:ref/statuses"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposListStatusesForRefResponseDataItemCreator = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposListStatusesForRefResponseDataItem = { + url: string; + avatar_url: string; + id: number; + node_id: string; + state: string; + description: string; + target_url: string; + context: string; + created_at: string; + updated_at: string; + creator: ReposListStatusesForRefResponseDataItemCreator; +}; +type ReposListStatusesForRefResponseData = Array< + ReposListStatusesForRefResponseDataItem +>; + type CodesOfConductGetForRepoEndpoint = { /** * owner parameter @@ -6750,13 +22422,21 @@ type CodesOfConductGetForRepoEndpoint = { * repo parameter */ repo: string; -}; +} & RequiredPreview<"scarlet-witch">; + type CodesOfConductGetForRepoRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/community/code_of_conduct"; headers: RequestHeaders; request: RequestRequestOptions; }; +type CodesOfConductGetForRepoResponseData = { + key: string; + name: string; + url: string; + body: string; +}; + type ReposRetrieveCommunityProfileMetricsEndpoint = { /** * owner parameter @@ -6767,12 +22447,58 @@ type ReposRetrieveCommunityProfileMetricsEndpoint = { */ repo: string; }; + type ReposRetrieveCommunityProfileMetricsRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/community/profile"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposRetrieveCommunityProfileMetricsResponseDataFilesReadme = { + url: string; + html_url: string; +}; +type ReposRetrieveCommunityProfileMetricsResponseDataFilesLicense = { + name: string; + key: string; + spdx_id: string; + url: string; + html_url: string; +}; +type ReposRetrieveCommunityProfileMetricsResponseDataFilesPullRequestTemplate = { + url: string; + html_url: string; +}; +type ReposRetrieveCommunityProfileMetricsResponseDataFilesIssueTemplate = { + url: string; + html_url: string; +}; +type ReposRetrieveCommunityProfileMetricsResponseDataFilesContributing = { + url: string; + html_url: string; +}; +type ReposRetrieveCommunityProfileMetricsResponseDataFilesCodeOfConduct = { + name: string; + key: string; + url: string; + html_url: string; +}; +type ReposRetrieveCommunityProfileMetricsResponseDataFiles = { + code_of_conduct: ReposRetrieveCommunityProfileMetricsResponseDataFilesCodeOfConduct; + contributing: ReposRetrieveCommunityProfileMetricsResponseDataFilesContributing; + issue_template: ReposRetrieveCommunityProfileMetricsResponseDataFilesIssueTemplate; + pull_request_template: ReposRetrieveCommunityProfileMetricsResponseDataFilesPullRequestTemplate; + license: ReposRetrieveCommunityProfileMetricsResponseDataFilesLicense; + readme: ReposRetrieveCommunityProfileMetricsResponseDataFilesReadme; +}; +type ReposRetrieveCommunityProfileMetricsResponseData = { + health_percentage: number; + description: string; + documentation: boolean; + files: ReposRetrieveCommunityProfileMetricsResponseDataFiles; + updated_at: string; +}; + type ReposCompareCommitsEndpoint = { /** * owner parameter @@ -6791,12 +22517,293 @@ type ReposCompareCommitsEndpoint = { */ head: string; }; + type ReposCompareCommitsRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/compare/:base...:head"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposCompareCommitsResponseDataFilesItem = { + sha: string; + filename: string; + status: string; + additions: number; + deletions: number; + changes: number; + blob_url: string; + raw_url: string; + contents_url: string; + patch: string; +}; +type ReposCompareCommitsResponseDataCommitsItemParentsItem = { + url: string; + sha: string; +}; +type ReposCompareCommitsResponseDataCommitsItemCommitter = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposCompareCommitsResponseDataCommitsItemAuthor = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposCompareCommitsResponseDataCommitsItemCommitVerification = { + verified: boolean; + reason: string; + signature: null; + payload: null; +}; +type ReposCompareCommitsResponseDataCommitsItemCommitTree = { + url: string; + sha: string; +}; +type ReposCompareCommitsResponseDataCommitsItemCommitCommitter = { + name: string; + email: string; + date: string; +}; +type ReposCompareCommitsResponseDataCommitsItemCommitAuthor = { + name: string; + email: string; + date: string; +}; +type ReposCompareCommitsResponseDataCommitsItemCommit = { + url: string; + author: ReposCompareCommitsResponseDataCommitsItemCommitAuthor; + committer: ReposCompareCommitsResponseDataCommitsItemCommitCommitter; + message: string; + tree: ReposCompareCommitsResponseDataCommitsItemCommitTree; + comment_count: number; + verification: ReposCompareCommitsResponseDataCommitsItemCommitVerification; +}; +type ReposCompareCommitsResponseDataCommitsItem = { + url: string; + sha: string; + node_id: string; + html_url: string; + comments_url: string; + commit: ReposCompareCommitsResponseDataCommitsItemCommit; + author: ReposCompareCommitsResponseDataCommitsItemAuthor; + committer: ReposCompareCommitsResponseDataCommitsItemCommitter; + parents: Array; +}; +type ReposCompareCommitsResponseDataMergeBaseCommitParentsItem = { + url: string; + sha: string; +}; +type ReposCompareCommitsResponseDataMergeBaseCommitCommitter = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposCompareCommitsResponseDataMergeBaseCommitAuthor = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposCompareCommitsResponseDataMergeBaseCommitCommitVerification = { + verified: boolean; + reason: string; + signature: null; + payload: null; +}; +type ReposCompareCommitsResponseDataMergeBaseCommitCommitTree = { + url: string; + sha: string; +}; +type ReposCompareCommitsResponseDataMergeBaseCommitCommitCommitter = { + name: string; + email: string; + date: string; +}; +type ReposCompareCommitsResponseDataMergeBaseCommitCommitAuthor = { + name: string; + email: string; + date: string; +}; +type ReposCompareCommitsResponseDataMergeBaseCommitCommit = { + url: string; + author: ReposCompareCommitsResponseDataMergeBaseCommitCommitAuthor; + committer: ReposCompareCommitsResponseDataMergeBaseCommitCommitCommitter; + message: string; + tree: ReposCompareCommitsResponseDataMergeBaseCommitCommitTree; + comment_count: number; + verification: ReposCompareCommitsResponseDataMergeBaseCommitCommitVerification; +}; +type ReposCompareCommitsResponseDataMergeBaseCommit = { + url: string; + sha: string; + node_id: string; + html_url: string; + comments_url: string; + commit: ReposCompareCommitsResponseDataMergeBaseCommitCommit; + author: ReposCompareCommitsResponseDataMergeBaseCommitAuthor; + committer: ReposCompareCommitsResponseDataMergeBaseCommitCommitter; + parents: Array; +}; +type ReposCompareCommitsResponseDataBaseCommitParentsItem = { + url: string; + sha: string; +}; +type ReposCompareCommitsResponseDataBaseCommitCommitter = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposCompareCommitsResponseDataBaseCommitAuthor = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposCompareCommitsResponseDataBaseCommitCommitVerification = { + verified: boolean; + reason: string; + signature: null; + payload: null; +}; +type ReposCompareCommitsResponseDataBaseCommitCommitTree = { + url: string; + sha: string; +}; +type ReposCompareCommitsResponseDataBaseCommitCommitCommitter = { + name: string; + email: string; + date: string; +}; +type ReposCompareCommitsResponseDataBaseCommitCommitAuthor = { + name: string; + email: string; + date: string; +}; +type ReposCompareCommitsResponseDataBaseCommitCommit = { + url: string; + author: ReposCompareCommitsResponseDataBaseCommitCommitAuthor; + committer: ReposCompareCommitsResponseDataBaseCommitCommitCommitter; + message: string; + tree: ReposCompareCommitsResponseDataBaseCommitCommitTree; + comment_count: number; + verification: ReposCompareCommitsResponseDataBaseCommitCommitVerification; +}; +type ReposCompareCommitsResponseDataBaseCommit = { + url: string; + sha: string; + node_id: string; + html_url: string; + comments_url: string; + commit: ReposCompareCommitsResponseDataBaseCommitCommit; + author: ReposCompareCommitsResponseDataBaseCommitAuthor; + committer: ReposCompareCommitsResponseDataBaseCommitCommitter; + parents: Array; +}; +type ReposCompareCommitsResponseData = { + url: string; + html_url: string; + permalink_url: string; + diff_url: string; + patch_url: string; + base_commit: ReposCompareCommitsResponseDataBaseCommit; + merge_base_commit: ReposCompareCommitsResponseDataMergeBaseCommit; + status: string; + ahead_by: number; + behind_by: number; + total_commits: number; + commits: Array; + files: Array; +}; + type ReposGetContentsEndpoint = { /** * owner parameter @@ -6815,12 +22822,54 @@ type ReposGetContentsEndpoint = { */ ref?: string; }; + type ReposGetContentsRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/contents/:path"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposGetContentsResponseDataItemLinks = { + self: string; + git: string; + html: string; +}; +type ReposGetContentsResponseDataItem = { + type: string; + size: number; + name: string; + path: string; + sha: string; + url: string; + git_url: string; + html_url: string; + download_url: string | null; + _links: ReposGetContentsResponseDataItemLinks; +}; +type ReposGetContentsResponseDataLinks = { + git: string; + self: string; + html: string; +}; +type ReposGetContentsResponseData = + | { + type: string; + encoding?: string; + size: number; + name: string; + path: string; + content?: string; + sha: string; + url: string; + git_url: string; + html_url: string; + download_url: string | null; + _links: ReposGetContentsResponseDataLinks; + target?: string; + submodule_git_url?: string; + } + | Array; + type ReposCreateOrUpdateFileEndpoint = { /** * owner parameter @@ -6859,100 +22908,72 @@ type ReposCreateOrUpdateFileEndpoint = { */ author?: ReposCreateOrUpdateFileParamsAuthor; }; + type ReposCreateOrUpdateFileRequestOptions = { method: "PUT"; - url: Url; + url: "/repos/:owner/:repo/contents/:path"; headers: RequestHeaders; request: RequestRequestOptions; }; -type ReposCreateFileEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * path parameter - */ - path: string; - /** - * The commit message. - */ +type ReposCreateOrUpdateFileResponseDataCommitVerification = { + verified: boolean; + reason: string; + signature: null; + payload: null; +}; +type ReposCreateOrUpdateFileResponseDataCommitParentsItem = { + url: string; + html_url: string; + sha: string; +}; +type ReposCreateOrUpdateFileResponseDataCommitTree = { + url: string; + sha: string; +}; +type ReposCreateOrUpdateFileResponseDataCommitCommitter = { + date: string; + name: string; + email: string; +}; +type ReposCreateOrUpdateFileResponseDataCommitAuthor = { + date: string; + name: string; + email: string; +}; +type ReposCreateOrUpdateFileResponseDataCommit = { + sha: string; + node_id: string; + url: string; + html_url: string; + author: ReposCreateOrUpdateFileResponseDataCommitAuthor; + committer: ReposCreateOrUpdateFileResponseDataCommitCommitter; message: string; - /** - * The new file content, using Base64 encoding. - */ - content: string; - /** - * **Required if you are updating a file**. The blob SHA of the file being replaced. - */ - sha?: string; - /** - * The branch name. Default: the repository’s default branch (usually `master`) - */ - branch?: string; - /** - * The person that committed the file. Default: the authenticated user. - */ - committer?: ReposCreateFileParamsCommitter; - /** - * The author of the file. Default: The `committer` or the authenticated user if you omit `committer`. - */ - author?: ReposCreateFileParamsAuthor; + tree: ReposCreateOrUpdateFileResponseDataCommitTree; + parents: Array; + verification: ReposCreateOrUpdateFileResponseDataCommitVerification; }; -type ReposCreateFileRequestOptions = { - method: "PUT"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; +type ReposCreateOrUpdateFileResponseDataContentLinks = { + self: string; + git: string; + html: string; }; -type ReposUpdateFileEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * path parameter - */ +type ReposCreateOrUpdateFileResponseDataContent = { + name: string; path: string; - /** - * The commit message. - */ - message: string; - /** - * The new file content, using Base64 encoding. - */ - content: string; - /** - * **Required if you are updating a file**. The blob SHA of the file being replaced. - */ - sha?: string; - /** - * The branch name. Default: the repository’s default branch (usually `master`) - */ - branch?: string; - /** - * The person that committed the file. Default: the authenticated user. - */ - committer?: ReposUpdateFileParamsCommitter; - /** - * The author of the file. Default: The `committer` or the authenticated user if you omit `committer`. - */ - author?: ReposUpdateFileParamsAuthor; + sha: string; + size: number; + url: string; + html_url: string; + git_url: string; + download_url: string; + type: string; + _links: ReposCreateOrUpdateFileResponseDataContentLinks; }; -type ReposUpdateFileRequestOptions = { - method: "PUT"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; +type ReposCreateOrUpdateFileResponseData = { + content: ReposCreateOrUpdateFileResponseDataContent; + commit: ReposCreateOrUpdateFileResponseDataCommit; }; + type ReposDeleteFileEndpoint = { /** * owner parameter @@ -6987,12 +23008,52 @@ type ReposDeleteFileEndpoint = { */ author?: ReposDeleteFileParamsAuthor; }; + type ReposDeleteFileRequestOptions = { method: "DELETE"; - url: Url; + url: "/repos/:owner/:repo/contents/:path"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposDeleteFileResponseDataCommitVerification = { + verified: boolean; + reason: string; + signature: null; + payload: null; +}; +type ReposDeleteFileResponseDataCommitParentsItem = { + url: string; + html_url: string; + sha: string; +}; +type ReposDeleteFileResponseDataCommitTree = { url: string; sha: string }; +type ReposDeleteFileResponseDataCommitCommitter = { + date: string; + name: string; + email: string; +}; +type ReposDeleteFileResponseDataCommitAuthor = { + date: string; + name: string; + email: string; +}; +type ReposDeleteFileResponseDataCommit = { + sha: string; + node_id: string; + url: string; + html_url: string; + author: ReposDeleteFileResponseDataCommitAuthor; + committer: ReposDeleteFileResponseDataCommitCommitter; + message: string; + tree: ReposDeleteFileResponseDataCommitTree; + parents: Array; + verification: ReposDeleteFileResponseDataCommitVerification; +}; +type ReposDeleteFileResponseData = { + content: null; + commit: ReposDeleteFileResponseDataCommit; +}; + type ReposListContributorsEndpoint = { /** * owner parameter @@ -7015,12 +23076,38 @@ type ReposListContributorsEndpoint = { */ page?: number; }; + type ReposListContributorsRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/contributors"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposListContributorsResponseDataItem = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + contributions: number; +}; +type ReposListContributorsResponseData = Array< + ReposListContributorsResponseDataItem +>; + type ReposListDeploymentsEndpoint = { /** * owner parameter @@ -7055,12 +23142,57 @@ type ReposListDeploymentsEndpoint = { */ page?: number; }; + type ReposListDeploymentsRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/deployments"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposListDeploymentsResponseDataItemCreator = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposListDeploymentsResponseDataItemPayload = { deploy: string }; +type ReposListDeploymentsResponseDataItem = { + url: string; + id: number; + node_id: string; + sha: string; + ref: string; + task: string; + payload: ReposListDeploymentsResponseDataItemPayload; + original_environment: string; + environment: string; + description: string; + creator: ReposListDeploymentsResponseDataItemCreator; + created_at: string; + updated_at: string; + statuses_url: string; + repository_url: string; + transient_environment: boolean; + production_environment: boolean; +}; +type ReposListDeploymentsResponseData = Array< + ReposListDeploymentsResponseDataItem +>; + type ReposCreateDeploymentEndpoint = { /** * owner parameter @@ -7109,12 +23241,54 @@ type ReposCreateDeploymentEndpoint = { */ production_environment?: boolean; }; + type ReposCreateDeploymentRequestOptions = { method: "POST"; - url: Url; + url: "/repos/:owner/:repo/deployments"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposCreateDeploymentResponseDataCreator = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposCreateDeploymentResponseDataPayload = { deploy: string }; +type ReposCreateDeploymentResponseData = { + url: string; + id: number; + node_id: string; + sha: string; + ref: string; + task: string; + payload: ReposCreateDeploymentResponseDataPayload; + original_environment: string; + environment: string; + description: string; + creator: ReposCreateDeploymentResponseDataCreator; + created_at: string; + updated_at: string; + statuses_url: string; + repository_url: string; + transient_environment: boolean; + production_environment: boolean; +}; + type ReposGetDeploymentEndpoint = { /** * owner parameter @@ -7129,12 +23303,76 @@ type ReposGetDeploymentEndpoint = { */ deployment_id: number; }; + type ReposGetDeploymentRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/deployments/:deployment_id"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposGetDeploymentResponseDataCreator = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposGetDeploymentResponseDataPayload = { deploy: string }; +type ReposGetDeploymentResponseData = { + url: string; + id: number; + node_id: string; + sha: string; + ref: string; + task: string; + payload: ReposGetDeploymentResponseDataPayload; + original_environment: string; + environment: string; + description: string; + creator: ReposGetDeploymentResponseDataCreator; + created_at: string; + updated_at: string; + statuses_url: string; + repository_url: string; + transient_environment: boolean; + production_environment: boolean; +}; + +type ReposDeleteDeploymentEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * deployment_id parameter + */ + deployment_id: number; +}; + +type ReposDeleteDeploymentRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/deployments/:deployment_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; + type ReposListDeploymentStatusesEndpoint = { /** * owner parameter @@ -7157,12 +23395,53 @@ type ReposListDeploymentStatusesEndpoint = { */ page?: number; }; + type ReposListDeploymentStatusesRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/deployments/:deployment_id/statuses"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposListDeploymentStatusesResponseDataItemCreator = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposListDeploymentStatusesResponseDataItem = { + url: string; + id: number; + node_id: string; + state: string; + creator: ReposListDeploymentStatusesResponseDataItemCreator; + description: string; + environment: string; + target_url: string; + created_at: string; + updated_at: string; + deployment_url: string; + repository_url: string; + environment_url: string; + log_url: string; +}; +type ReposListDeploymentStatusesResponseData = Array< + ReposListDeploymentStatusesResponseDataItem +>; + type ReposCreateDeploymentStatusEndpoint = { /** * owner parameter @@ -7216,12 +23495,50 @@ type ReposCreateDeploymentStatusEndpoint = { */ auto_inactive?: boolean; }; + type ReposCreateDeploymentStatusRequestOptions = { method: "POST"; - url: Url; + url: "/repos/:owner/:repo/deployments/:deployment_id/statuses"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposCreateDeploymentStatusResponseDataCreator = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposCreateDeploymentStatusResponseData = { + url: string; + id: number; + node_id: string; + state: string; + creator: ReposCreateDeploymentStatusResponseDataCreator; + description: string; + environment: string; + target_url: string; + created_at: string; + updated_at: string; + deployment_url: string; + repository_url: string; + environment_url: string; + log_url: string; +}; + type ReposGetDeploymentStatusEndpoint = { /** * owner parameter @@ -7240,12 +23557,50 @@ type ReposGetDeploymentStatusEndpoint = { */ status_id: number; }; + type ReposGetDeploymentStatusRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/deployments/:deployment_id/statuses/:status_id"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposGetDeploymentStatusResponseDataCreator = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposGetDeploymentStatusResponseData = { + url: string; + id: number; + node_id: string; + state: string; + creator: ReposGetDeploymentStatusResponseDataCreator; + description: string; + environment: string; + target_url: string; + created_at: string; + updated_at: string; + deployment_url: string; + repository_url: string; + environment_url: string; + log_url: string; +}; + type ReposCreateDispatchEventEndpoint = { /** * owner parameter @@ -7259,13 +23614,19 @@ type ReposCreateDispatchEventEndpoint = { * **Required:** A custom webhook event name. */ event_type?: string; + /** + * JSON payload with extra information about the webhook event that your action or worklow may use. + */ + client_payload?: ReposCreateDispatchEventParamsClientPayload; }; + type ReposCreateDispatchEventRequestOptions = { method: "POST"; - url: Url; + url: "/repos/:owner/:repo/dispatches"; headers: RequestHeaders; request: RequestRequestOptions; }; + type ReposListDownloadsEndpoint = { /** * owner parameter @@ -7284,12 +23645,25 @@ type ReposListDownloadsEndpoint = { */ page?: number; }; + type ReposListDownloadsRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/downloads"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposListDownloadsResponseDataItem = { + url: string; + html_url: string; + id: number; + name: string; + description: string; + size: number; + download_count: number; + content_type: string; +}; +type ReposListDownloadsResponseData = Array; + type ReposGetDownloadEndpoint = { /** * owner parameter @@ -7304,12 +23678,24 @@ type ReposGetDownloadEndpoint = { */ download_id: number; }; + type ReposGetDownloadRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/downloads/:download_id"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposGetDownloadResponseData = { + url: string; + html_url: string; + id: number; + name: string; + description: string; + size: number; + download_count: number; + content_type: string; +}; + type ReposDeleteDownloadEndpoint = { /** * owner parameter @@ -7324,12 +23710,14 @@ type ReposDeleteDownloadEndpoint = { */ download_id: number; }; + type ReposDeleteDownloadRequestOptions = { method: "DELETE"; - url: Url; + url: "/repos/:owner/:repo/downloads/:download_id"; headers: RequestHeaders; request: RequestRequestOptions; }; + type ActivityListRepoEventsEndpoint = { /** * owner parameter @@ -7348,12 +23736,14 @@ type ActivityListRepoEventsEndpoint = { */ page?: number; }; + type ActivityListRepoEventsRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/events"; headers: RequestHeaders; request: RequestRequestOptions; }; + type ReposListForksEndpoint = { /** * owner parameter @@ -7376,12 +23766,127 @@ type ReposListForksEndpoint = { */ page?: number; }; + type ReposListForksRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/forks"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposListForksResponseDataItemLicense = { + key: string; + name: string; + spdx_id: string; + url: string; + node_id: string; +}; +type ReposListForksResponseDataItemPermissions = { + admin: boolean; + push: boolean; + pull: boolean; +}; +type ReposListForksResponseDataItemOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposListForksResponseDataItem = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: ReposListForksResponseDataItemOwner; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: null; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: Array; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: ReposListForksResponseDataItemPermissions; + template_repository: null; + temp_clone_token: string; + subscribers_count: number; + network_count: number; + license: ReposListForksResponseDataItemLicense; +}; +type ReposListForksResponseData = Array; + type ReposCreateForkEndpoint = { /** * owner parameter @@ -7396,12 +23901,121 @@ type ReposCreateForkEndpoint = { */ organization?: string; }; + type ReposCreateForkRequestOptions = { method: "POST"; - url: Url; + url: "/repos/:owner/:repo/forks"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposCreateForkResponseDataPermissions = { + admin: boolean; + push: boolean; + pull: boolean; +}; +type ReposCreateForkResponseDataOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposCreateForkResponseData = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: ReposCreateForkResponseDataOwner; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: null; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: Array; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: ReposCreateForkResponseDataPermissions; + allow_rebase_merge: boolean; + template_repository: null; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; +}; + type GitCreateBlobEndpoint = { /** * owner parameter @@ -7420,12 +24034,15 @@ type GitCreateBlobEndpoint = { */ encoding?: string; }; + type GitCreateBlobRequestOptions = { method: "POST"; - url: Url; + url: "/repos/:owner/:repo/git/blobs"; headers: RequestHeaders; request: RequestRequestOptions; }; +type GitCreateBlobResponseData = { url: string; sha: string }; + type GitGetBlobEndpoint = { /** * owner parameter @@ -7440,12 +24057,21 @@ type GitGetBlobEndpoint = { */ file_sha: string; }; + type GitGetBlobRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/git/blobs/:file_sha"; headers: RequestHeaders; request: RequestRequestOptions; }; +type GitGetBlobResponseData = { + content: string; + encoding: string; + url: string; + sha: string; + size: number; +}; + type GitCreateCommitEndpoint = { /** * owner parameter @@ -7480,12 +24106,43 @@ type GitCreateCommitEndpoint = { */ signature?: string; }; + type GitCreateCommitRequestOptions = { method: "POST"; - url: Url; + url: "/repos/:owner/:repo/git/commits"; headers: RequestHeaders; request: RequestRequestOptions; }; +type GitCreateCommitResponseDataVerification = { + verified: boolean; + reason: string; + signature: null; + payload: null; +}; +type GitCreateCommitResponseDataParentsItem = { url: string; sha: string }; +type GitCreateCommitResponseDataTree = { url: string; sha: string }; +type GitCreateCommitResponseDataCommitter = { + date: string; + name: string; + email: string; +}; +type GitCreateCommitResponseDataAuthor = { + date: string; + name: string; + email: string; +}; +type GitCreateCommitResponseData = { + sha: string; + node_id: string; + url: string; + author: GitCreateCommitResponseDataAuthor; + committer: GitCreateCommitResponseDataCommitter; + message: string; + tree: GitCreateCommitResponseDataTree; + parents: Array; + verification: GitCreateCommitResponseDataVerification; +}; + type GitGetCommitEndpoint = { /** * owner parameter @@ -7500,12 +24157,42 @@ type GitGetCommitEndpoint = { */ commit_sha: string; }; + type GitGetCommitRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/git/commits/:commit_sha"; headers: RequestHeaders; request: RequestRequestOptions; }; +type GitGetCommitResponseDataVerification = { + verified: boolean; + reason: string; + signature: null; + payload: null; +}; +type GitGetCommitResponseDataParentsItem = { url: string; sha: string }; +type GitGetCommitResponseDataTree = { url: string; sha: string }; +type GitGetCommitResponseDataCommitter = { + date: string; + name: string; + email: string; +}; +type GitGetCommitResponseDataAuthor = { + date: string; + name: string; + email: string; +}; +type GitGetCommitResponseData = { + sha: string; + url: string; + author: GitGetCommitResponseDataAuthor; + committer: GitGetCommitResponseDataCommitter; + message: string; + tree: GitGetCommitResponseDataTree; + parents: Array; + verification: GitGetCommitResponseDataVerification; +}; + type GitListMatchingRefsEndpoint = { /** * owner parameter @@ -7528,12 +24215,28 @@ type GitListMatchingRefsEndpoint = { */ page?: number; }; + type GitListMatchingRefsRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/git/matching-refs/:ref"; headers: RequestHeaders; request: RequestRequestOptions; }; +type GitListMatchingRefsResponseDataItemObject = { + type: string; + sha: string; + url: string; +}; +type GitListMatchingRefsResponseDataItem = { + ref: string; + node_id: string; + url: string; + object: GitListMatchingRefsResponseDataItemObject; +}; +type GitListMatchingRefsResponseData = Array< + GitListMatchingRefsResponseDataItem +>; + type GitGetRefEndpoint = { /** * owner parameter @@ -7548,12 +24251,21 @@ type GitGetRefEndpoint = { */ ref: string; }; + type GitGetRefRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/git/ref/:ref"; headers: RequestHeaders; request: RequestRequestOptions; }; +type GitGetRefResponseDataObject = { type: string; sha: string; url: string }; +type GitGetRefResponseData = { + ref: string; + node_id: string; + url: string; + object: GitGetRefResponseDataObject; +}; + type GitCreateRefEndpoint = { /** * owner parameter @@ -7572,12 +24284,25 @@ type GitCreateRefEndpoint = { */ sha: string; }; + type GitCreateRefRequestOptions = { method: "POST"; - url: Url; + url: "/repos/:owner/:repo/git/refs"; headers: RequestHeaders; request: RequestRequestOptions; }; +type GitCreateRefResponseDataObject = { + type: string; + sha: string; + url: string; +}; +type GitCreateRefResponseData = { + ref: string; + node_id: string; + url: string; + object: GitCreateRefResponseDataObject; +}; + type GitUpdateRefEndpoint = { /** * owner parameter @@ -7600,12 +24325,25 @@ type GitUpdateRefEndpoint = { */ force?: boolean; }; + type GitUpdateRefRequestOptions = { method: "PATCH"; - url: Url; + url: "/repos/:owner/:repo/git/refs/:ref"; headers: RequestHeaders; request: RequestRequestOptions; }; +type GitUpdateRefResponseDataObject = { + type: string; + sha: string; + url: string; +}; +type GitUpdateRefResponseData = { + ref: string; + node_id: string; + url: string; + object: GitUpdateRefResponseDataObject; +}; + type GitDeleteRefEndpoint = { /** * owner parameter @@ -7620,12 +24358,14 @@ type GitDeleteRefEndpoint = { */ ref: string; }; + type GitDeleteRefRequestOptions = { method: "DELETE"; - url: Url; + url: "/repos/:owner/:repo/git/refs/:ref"; headers: RequestHeaders; request: RequestRequestOptions; }; + type GitCreateTagEndpoint = { /** * owner parameter @@ -7656,12 +24396,40 @@ type GitCreateTagEndpoint = { */ tagger?: GitCreateTagParamsTagger; }; + type GitCreateTagRequestOptions = { method: "POST"; - url: Url; + url: "/repos/:owner/:repo/git/tags"; headers: RequestHeaders; request: RequestRequestOptions; }; +type GitCreateTagResponseDataVerification = { + verified: boolean; + reason: string; + signature: null; + payload: null; +}; +type GitCreateTagResponseDataObject = { + type: string; + sha: string; + url: string; +}; +type GitCreateTagResponseDataTagger = { + name: string; + email: string; + date: string; +}; +type GitCreateTagResponseData = { + node_id: string; + tag: string; + sha: string; + url: string; + message: string; + tagger: GitCreateTagResponseDataTagger; + object: GitCreateTagResponseDataObject; + verification: GitCreateTagResponseDataVerification; +}; + type GitGetTagEndpoint = { /** * owner parameter @@ -7676,12 +24444,36 @@ type GitGetTagEndpoint = { */ tag_sha: string; }; + type GitGetTagRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/git/tags/:tag_sha"; headers: RequestHeaders; request: RequestRequestOptions; }; +type GitGetTagResponseDataVerification = { + verified: boolean; + reason: string; + signature: null; + payload: null; +}; +type GitGetTagResponseDataObject = { type: string; sha: string; url: string }; +type GitGetTagResponseDataTagger = { + name: string; + email: string; + date: string; +}; +type GitGetTagResponseData = { + node_id: string; + tag: string; + sha: string; + url: string; + message: string; + tagger: GitGetTagResponseDataTagger; + object: GitGetTagResponseDataObject; + verification: GitGetTagResponseDataVerification; +}; + type GitCreateTreeEndpoint = { /** * owner parameter @@ -7700,12 +24492,27 @@ type GitCreateTreeEndpoint = { */ base_tree?: string; }; + type GitCreateTreeRequestOptions = { method: "POST"; - url: Url; + url: "/repos/:owner/:repo/git/trees"; headers: RequestHeaders; request: RequestRequestOptions; }; +type GitCreateTreeResponseDataTreeItem = { + path: string; + mode: string; + type: string; + size: number; + sha: string; + url: string; +}; +type GitCreateTreeResponseData = { + sha: string; + url: string; + tree: Array; +}; + type GitGetTreeEndpoint = { /** * owner parameter @@ -7724,12 +24531,28 @@ type GitGetTreeEndpoint = { */ recursive?: "1"; }; + type GitGetTreeRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/git/trees/:tree_sha"; headers: RequestHeaders; request: RequestRequestOptions; }; +type GitGetTreeResponseDataTreeItem = { + path: string; + mode: string; + type: string; + size?: number; + sha: string; + url: string; +}; +type GitGetTreeResponseData = { + sha: string; + url: string; + tree: Array; + truncated: boolean; +}; + type ReposListHooksEndpoint = { /** * owner parameter @@ -7748,12 +24571,39 @@ type ReposListHooksEndpoint = { */ page?: number; }; + type ReposListHooksRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/hooks"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposListHooksResponseDataItemLastResponse = { + code: null; + status: string; + message: null; +}; +type ReposListHooksResponseDataItemConfig = { + content_type: string; + insecure_ssl: string; + url: string; +}; +type ReposListHooksResponseDataItem = { + type: string; + id: number; + name: string; + active: boolean; + events: Array; + config: ReposListHooksResponseDataItemConfig; + updated_at: string; + created_at: string; + url: string; + test_url: string; + ping_url: string; + last_response: ReposListHooksResponseDataItemLastResponse; +}; +type ReposListHooksResponseData = Array; + type ReposCreateHookEndpoint = { /** * owner parameter @@ -7780,12 +24630,38 @@ type ReposCreateHookEndpoint = { */ active?: boolean; }; + type ReposCreateHookRequestOptions = { method: "POST"; - url: Url; + url: "/repos/:owner/:repo/hooks"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposCreateHookResponseDataLastResponse = { + code: null; + status: string; + message: null; +}; +type ReposCreateHookResponseDataConfig = { + content_type: string; + insecure_ssl: string; + url: string; +}; +type ReposCreateHookResponseData = { + type: string; + id: number; + name: string; + active: boolean; + events: Array; + config: ReposCreateHookResponseDataConfig; + updated_at: string; + created_at: string; + url: string; + test_url: string; + ping_url: string; + last_response: ReposCreateHookResponseDataLastResponse; +}; + type ReposGetHookEndpoint = { /** * owner parameter @@ -7800,12 +24676,38 @@ type ReposGetHookEndpoint = { */ hook_id: number; }; + type ReposGetHookRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/hooks/:hook_id"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposGetHookResponseDataLastResponse = { + code: null; + status: string; + message: null; +}; +type ReposGetHookResponseDataConfig = { + content_type: string; + insecure_ssl: string; + url: string; +}; +type ReposGetHookResponseData = { + type: string; + id: number; + name: string; + active: boolean; + events: Array; + config: ReposGetHookResponseDataConfig; + updated_at: string; + created_at: string; + url: string; + test_url: string; + ping_url: string; + last_response: ReposGetHookResponseDataLastResponse; +}; + type ReposUpdateHookEndpoint = { /** * owner parameter @@ -7840,12 +24742,38 @@ type ReposUpdateHookEndpoint = { */ active?: boolean; }; + type ReposUpdateHookRequestOptions = { method: "PATCH"; - url: Url; + url: "/repos/:owner/:repo/hooks/:hook_id"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposUpdateHookResponseDataLastResponse = { + code: null; + status: string; + message: null; +}; +type ReposUpdateHookResponseDataConfig = { + content_type: string; + insecure_ssl: string; + url: string; +}; +type ReposUpdateHookResponseData = { + type: string; + id: number; + name: string; + active: boolean; + events: Array; + config: ReposUpdateHookResponseDataConfig; + updated_at: string; + created_at: string; + url: string; + test_url: string; + ping_url: string; + last_response: ReposUpdateHookResponseDataLastResponse; +}; + type ReposDeleteHookEndpoint = { /** * owner parameter @@ -7860,12 +24788,14 @@ type ReposDeleteHookEndpoint = { */ hook_id: number; }; + type ReposDeleteHookRequestOptions = { method: "DELETE"; - url: Url; + url: "/repos/:owner/:repo/hooks/:hook_id"; headers: RequestHeaders; request: RequestRequestOptions; }; + type ReposPingHookEndpoint = { /** * owner parameter @@ -7880,12 +24810,14 @@ type ReposPingHookEndpoint = { */ hook_id: number; }; + type ReposPingHookRequestOptions = { method: "POST"; - url: Url; + url: "/repos/:owner/:repo/hooks/:hook_id/pings"; headers: RequestHeaders; request: RequestRequestOptions; }; + type ReposTestPushHookEndpoint = { /** * owner parameter @@ -7900,12 +24832,14 @@ type ReposTestPushHookEndpoint = { */ hook_id: number; }; + type ReposTestPushHookRequestOptions = { method: "POST"; - url: Url; + url: "/repos/:owner/:repo/hooks/:hook_id/tests"; headers: RequestHeaders; request: RequestRequestOptions; }; + type MigrationsStartImportEndpoint = { /** * owner parameter @@ -7936,12 +24870,31 @@ type MigrationsStartImportEndpoint = { */ tfvc_project?: string; }; + type MigrationsStartImportRequestOptions = { method: "PUT"; - url: Url; + url: "/repos/:owner/:repo/import"; headers: RequestHeaders; request: RequestRequestOptions; }; +type MigrationsStartImportResponseData = { + vcs: string; + use_lfs: string; + vcs_url: string; + status: string; + status_text: string; + has_large_files: boolean; + large_files_size: number; + large_files_count: number; + authors_count: number; + percent: number; + commit_count: number; + url: string; + html_url: string; + authors_url: string; + repository_url: string; +}; + type MigrationsGetImportProgressEndpoint = { /** * owner parameter @@ -7952,12 +24905,29 @@ type MigrationsGetImportProgressEndpoint = { */ repo: string; }; + type MigrationsGetImportProgressRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/import"; headers: RequestHeaders; request: RequestRequestOptions; }; +type MigrationsGetImportProgressResponseData = { + vcs: string; + use_lfs: string; + vcs_url: string; + status: string; + status_text: string; + has_large_files: boolean; + large_files_size: number; + large_files_count: number; + authors_count: number; + url: string; + html_url: string; + authors_url: string; + repository_url: string; +}; + type MigrationsUpdateImportEndpoint = { /** * owner parameter @@ -7976,12 +24946,32 @@ type MigrationsUpdateImportEndpoint = { */ vcs_password?: string; }; + type MigrationsUpdateImportRequestOptions = { method: "PATCH"; - url: Url; + url: "/repos/:owner/:repo/import"; headers: RequestHeaders; request: RequestRequestOptions; }; +type MigrationsUpdateImportResponseData = { + vcs: string; + use_lfs: string; + vcs_url: string; + status: string; + url: string; + html_url: string; + authors_url: string; + repository_url: string; + tfvc_project?: string; + status_text?: string; + has_large_files?: boolean; + large_files_size?: number; + large_files_count?: number; + authors_count?: number; + percent?: number; + commit_count?: number; +}; + type MigrationsCancelImportEndpoint = { /** * owner parameter @@ -7992,12 +24982,14 @@ type MigrationsCancelImportEndpoint = { */ repo: string; }; + type MigrationsCancelImportRequestOptions = { method: "DELETE"; - url: Url; + url: "/repos/:owner/:repo/import"; headers: RequestHeaders; request: RequestRequestOptions; }; + type MigrationsGetCommitAuthorsEndpoint = { /** * owner parameter @@ -8012,12 +25004,26 @@ type MigrationsGetCommitAuthorsEndpoint = { */ since?: string; }; + type MigrationsGetCommitAuthorsRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/import/authors"; headers: RequestHeaders; request: RequestRequestOptions; }; +type MigrationsGetCommitAuthorsResponseDataItem = { + id: number; + remote_id: string; + remote_name: string; + email: string; + name: string; + url: string; + import_url: string; +}; +type MigrationsGetCommitAuthorsResponseData = Array< + MigrationsGetCommitAuthorsResponseDataItem +>; + type MigrationsMapCommitAuthorEndpoint = { /** * owner parameter @@ -8040,12 +25046,23 @@ type MigrationsMapCommitAuthorEndpoint = { */ name?: string; }; + type MigrationsMapCommitAuthorRequestOptions = { method: "PATCH"; - url: Url; + url: "/repos/:owner/:repo/import/authors/:author_id"; headers: RequestHeaders; request: RequestRequestOptions; }; +type MigrationsMapCommitAuthorResponseData = { + id: number; + remote_id: string; + remote_name: string; + email: string; + name: string; + url: string; + import_url: string; +}; + type MigrationsGetLargeFilesEndpoint = { /** * owner parameter @@ -8056,12 +25073,23 @@ type MigrationsGetLargeFilesEndpoint = { */ repo: string; }; + type MigrationsGetLargeFilesRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/import/large_files"; headers: RequestHeaders; request: RequestRequestOptions; }; +type MigrationsGetLargeFilesResponseDataItem = { + ref_name: string; + path: string; + oid: string; + size: number; +}; +type MigrationsGetLargeFilesResponseData = Array< + MigrationsGetLargeFilesResponseDataItem +>; + type MigrationsSetLfsPreferenceEndpoint = { /** * owner parameter @@ -8076,12 +25104,29 @@ type MigrationsSetLfsPreferenceEndpoint = { */ use_lfs: "opt_in" | "opt_out"; }; + type MigrationsSetLfsPreferenceRequestOptions = { method: "PATCH"; - url: Url; + url: "/repos/:owner/:repo/import/lfs"; headers: RequestHeaders; request: RequestRequestOptions; }; +type MigrationsSetLfsPreferenceResponseData = { + vcs: string; + use_lfs: string; + vcs_url: string; + status: string; + status_text: string; + has_large_files: boolean; + large_files_size: number; + large_files_count: number; + authors_count: number; + url: string; + html_url: string; + authors_url: string; + repository_url: string; +}; + type AppsGetRepoInstallationEndpoint = { /** * owner parameter @@ -8091,29 +25136,55 @@ type AppsGetRepoInstallationEndpoint = { * repo parameter */ repo: string; -}; +} & RequiredPreview<"machine-man">; + type AppsGetRepoInstallationRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/installation"; headers: RequestHeaders; request: RequestRequestOptions; }; -type AppsFindRepoInstallationEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; +type AppsGetRepoInstallationResponseDataPermissions = { + checks: string; + metadata: string; + contents: string; }; -type AppsFindRepoInstallationRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; +type AppsGetRepoInstallationResponseDataAccount = { + login: string; + id: number; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; }; +type AppsGetRepoInstallationResponseData = { + id: number; + account: AppsGetRepoInstallationResponseDataAccount; + repository_selection: string; + access_tokens_url: string; + repositories_url: string; + html_url: string; + app_id: number; + target_id: number; + target_type: string; + permissions: AppsGetRepoInstallationResponseDataPermissions; + events: Array; + created_at: string; + updated_at: string; + single_file_name: null; +}; + type InteractionsGetRestrictionsForRepoEndpoint = { /** * owner parameter @@ -8123,13 +25194,20 @@ type InteractionsGetRestrictionsForRepoEndpoint = { * repo parameter */ repo: string; -}; +} & RequiredPreview<"sombra">; + type InteractionsGetRestrictionsForRepoRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/interaction-limits"; headers: RequestHeaders; request: RequestRequestOptions; }; +type InteractionsGetRestrictionsForRepoResponseData = { + limit: string; + origin: string; + expires_at: string; +}; + type InteractionsAddOrUpdateRestrictionsForRepoEndpoint = { /** * owner parameter @@ -8143,13 +25221,20 @@ type InteractionsAddOrUpdateRestrictionsForRepoEndpoint = { * Specifies the group of GitHub users who can comment, open issues, or create pull requests for the given repository. Must be one of: `existing_users`, `contributors_only`, or `collaborators_only`. */ limit: "existing_users" | "contributors_only" | "collaborators_only"; -}; +} & RequiredPreview<"sombra">; + type InteractionsAddOrUpdateRestrictionsForRepoRequestOptions = { method: "PUT"; - url: Url; + url: "/repos/:owner/:repo/interaction-limits"; headers: RequestHeaders; request: RequestRequestOptions; }; +type InteractionsAddOrUpdateRestrictionsForRepoResponseData = { + limit: string; + origin: string; + expires_at: string; +}; + type InteractionsRemoveRestrictionsForRepoEndpoint = { /** * owner parameter @@ -8159,13 +25244,15 @@ type InteractionsRemoveRestrictionsForRepoEndpoint = { * repo parameter */ repo: string; -}; +} & RequiredPreview<"sombra">; + type InteractionsRemoveRestrictionsForRepoRequestOptions = { method: "DELETE"; - url: Url; + url: "/repos/:owner/:repo/interaction-limits"; headers: RequestHeaders; request: RequestRequestOptions; }; + type ReposListInvitationsEndpoint = { /** * owner parameter @@ -8184,12 +25271,136 @@ type ReposListInvitationsEndpoint = { */ page?: number; }; + type ReposListInvitationsRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/invitations"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposListInvitationsResponseDataItemInviter = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposListInvitationsResponseDataItemInvitee = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposListInvitationsResponseDataItemRepositoryOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposListInvitationsResponseDataItemRepository = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: ReposListInvitationsResponseDataItemRepositoryOwner; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; +}; +type ReposListInvitationsResponseDataItem = { + id: number; + repository: ReposListInvitationsResponseDataItemRepository; + invitee: ReposListInvitationsResponseDataItemInvitee; + inviter: ReposListInvitationsResponseDataItemInviter; + permissions: string; + created_at: string; + url: string; + html_url: string; +}; +type ReposListInvitationsResponseData = Array< + ReposListInvitationsResponseDataItem +>; + type ReposDeleteInvitationEndpoint = { /** * owner parameter @@ -8204,12 +25415,14 @@ type ReposDeleteInvitationEndpoint = { */ invitation_id: number; }; + type ReposDeleteInvitationRequestOptions = { method: "DELETE"; - url: Url; + url: "/repos/:owner/:repo/invitations/:invitation_id"; headers: RequestHeaders; request: RequestRequestOptions; }; + type ReposUpdateInvitationEndpoint = { /** * owner parameter @@ -8224,16 +25437,137 @@ type ReposUpdateInvitationEndpoint = { */ invitation_id: number; /** - * The permissions that the associated user will have on the repository. Valid values are `read`, `write`, and `admin`. + * The permissions that the associated user will have on the repository. Valid values are `read`, `write`, `maintain`, `triage`, and `admin`. */ - permissions?: "read" | "write" | "admin"; + permissions?: "read" | "write" | "maintain" | "triage" | "admin"; }; + type ReposUpdateInvitationRequestOptions = { method: "PATCH"; - url: Url; + url: "/repos/:owner/:repo/invitations/:invitation_id"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposUpdateInvitationResponseDataInviter = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposUpdateInvitationResponseDataInvitee = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposUpdateInvitationResponseDataRepositoryOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposUpdateInvitationResponseDataRepository = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: ReposUpdateInvitationResponseDataRepositoryOwner; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; +}; +type ReposUpdateInvitationResponseData = { + id: number; + repository: ReposUpdateInvitationResponseDataRepository; + invitee: ReposUpdateInvitationResponseDataInvitee; + inviter: ReposUpdateInvitationResponseDataInviter; + permissions: string; + created_at: string; + url: string; + html_url: string; +}; + type IssuesListForRepoEndpoint = { /** * owner parameter @@ -8288,12 +25622,154 @@ type IssuesListForRepoEndpoint = { */ page?: number; }; + type IssuesListForRepoRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/issues"; headers: RequestHeaders; request: RequestRequestOptions; }; +type IssuesListForRepoResponseDataItemPullRequest = { + url: string; + html_url: string; + diff_url: string; + patch_url: string; +}; +type IssuesListForRepoResponseDataItemMilestoneCreator = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type IssuesListForRepoResponseDataItemMilestone = { + url: string; + html_url: string; + labels_url: string; + id: number; + node_id: string; + number: number; + state: string; + title: string; + description: string; + creator: IssuesListForRepoResponseDataItemMilestoneCreator; + open_issues: number; + closed_issues: number; + created_at: string; + updated_at: string; + closed_at: string; + due_on: string; +}; +type IssuesListForRepoResponseDataItemAssigneesItem = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type IssuesListForRepoResponseDataItemAssignee = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type IssuesListForRepoResponseDataItemLabelsItem = { + id: number; + node_id: string; + url: string; + name: string; + description: string; + color: string; + default: boolean; +}; +type IssuesListForRepoResponseDataItemUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type IssuesListForRepoResponseDataItem = { + id: number; + node_id: string; + url: string; + repository_url: string; + labels_url: string; + comments_url: string; + events_url: string; + html_url: string; + number: number; + state: string; + title: string; + body: string; + user: IssuesListForRepoResponseDataItemUser; + labels: Array; + assignee: IssuesListForRepoResponseDataItemAssignee; + assignees: Array; + milestone: IssuesListForRepoResponseDataItemMilestone; + locked: boolean; + active_lock_reason: string; + comments: number; + pull_request: IssuesListForRepoResponseDataItemPullRequest; + closed_at: null; + created_at: string; + updated_at: string; +}; +type IssuesListForRepoResponseData = Array; + type IssuesCreateEndpoint = { /** * owner parameter @@ -8328,12 +25804,174 @@ type IssuesCreateEndpoint = { */ assignees?: string[]; }; + type IssuesCreateRequestOptions = { method: "POST"; - url: Url; + url: "/repos/:owner/:repo/issues"; headers: RequestHeaders; request: RequestRequestOptions; }; +type IssuesCreateResponseDataClosedBy = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type IssuesCreateResponseDataPullRequest = { + url: string; + html_url: string; + diff_url: string; + patch_url: string; +}; +type IssuesCreateResponseDataMilestoneCreator = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type IssuesCreateResponseDataMilestone = { + url: string; + html_url: string; + labels_url: string; + id: number; + node_id: string; + number: number; + state: string; + title: string; + description: string; + creator: IssuesCreateResponseDataMilestoneCreator; + open_issues: number; + closed_issues: number; + created_at: string; + updated_at: string; + closed_at: string; + due_on: string; +}; +type IssuesCreateResponseDataAssigneesItem = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type IssuesCreateResponseDataAssignee = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type IssuesCreateResponseDataLabelsItem = { + id: number; + node_id: string; + url: string; + name: string; + description: string; + color: string; + default: boolean; +}; +type IssuesCreateResponseDataUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type IssuesCreateResponseData = { + id: number; + node_id: string; + url: string; + repository_url: string; + labels_url: string; + comments_url: string; + events_url: string; + html_url: string; + number: number; + state: string; + title: string; + body: string; + user: IssuesCreateResponseDataUser; + labels: Array; + assignee: IssuesCreateResponseDataAssignee; + assignees: Array; + milestone: IssuesCreateResponseDataMilestone; + locked: boolean; + active_lock_reason: string; + comments: number; + pull_request: IssuesCreateResponseDataPullRequest; + closed_at: null; + created_at: string; + updated_at: string; + closed_by: IssuesCreateResponseDataClosedBy; +}; + type IssuesListCommentsForRepoEndpoint = { /** * owner parameter @@ -8355,13 +25993,56 @@ type IssuesListCommentsForRepoEndpoint = { * Only comments updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; }; + type IssuesListCommentsForRepoRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/issues/comments"; headers: RequestHeaders; request: RequestRequestOptions; }; +type IssuesListCommentsForRepoResponseDataItemUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type IssuesListCommentsForRepoResponseDataItem = { + id: number; + node_id: string; + url: string; + html_url: string; + body: string; + user: IssuesListCommentsForRepoResponseDataItemUser; + created_at: string; + updated_at: string; +}; +type IssuesListCommentsForRepoResponseData = Array< + IssuesListCommentsForRepoResponseDataItem +>; + type IssuesGetCommentEndpoint = { /** * owner parameter @@ -8375,21 +26056,45 @@ type IssuesGetCommentEndpoint = { * comment_id parameter */ comment_id: number; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; }; + type IssuesGetCommentRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/issues/comments/:comment_id"; headers: RequestHeaders; request: RequestRequestOptions; }; +type IssuesGetCommentResponseDataUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type IssuesGetCommentResponseData = { + id: number; + node_id: string; + url: string; + html_url: string; + body: string; + user: IssuesGetCommentResponseDataUser; + created_at: string; + updated_at: string; +}; + type IssuesUpdateCommentEndpoint = { /** * owner parameter @@ -8408,12 +26113,44 @@ type IssuesUpdateCommentEndpoint = { */ body: string; }; + type IssuesUpdateCommentRequestOptions = { method: "PATCH"; - url: Url; + url: "/repos/:owner/:repo/issues/comments/:comment_id"; headers: RequestHeaders; request: RequestRequestOptions; }; +type IssuesUpdateCommentResponseDataUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type IssuesUpdateCommentResponseData = { + id: number; + node_id: string; + url: string; + html_url: string; + body: string; + user: IssuesUpdateCommentResponseDataUser; + created_at: string; + updated_at: string; +}; + type IssuesDeleteCommentEndpoint = { /** * owner parameter @@ -8428,12 +26165,14 @@ type IssuesDeleteCommentEndpoint = { */ comment_id: number; }; + type IssuesDeleteCommentRequestOptions = { method: "DELETE"; - url: Url; + url: "/repos/:owner/:repo/issues/comments/:comment_id"; headers: RequestHeaders; request: RequestRequestOptions; }; + type ReactionsListForIssueCommentEndpoint = { /** * owner parameter @@ -8467,13 +26206,45 @@ type ReactionsListForIssueCommentEndpoint = { * Page number of the results to fetch. */ page?: number; -}; +} & RequiredPreview<"squirrel-girl">; + type ReactionsListForIssueCommentRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/issues/comments/:comment_id/reactions"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReactionsListForIssueCommentResponseDataItemUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReactionsListForIssueCommentResponseDataItem = { + id: number; + node_id: string; + user: ReactionsListForIssueCommentResponseDataItemUser; + content: string; + created_at: string; +}; +type ReactionsListForIssueCommentResponseData = Array< + ReactionsListForIssueCommentResponseDataItem +>; + type ReactionsCreateForIssueCommentEndpoint = { /** * owner parameter @@ -8499,13 +26270,68 @@ type ReactionsCreateForIssueCommentEndpoint = { | "hooray" | "rocket" | "eyes"; -}; +} & RequiredPreview<"squirrel-girl">; + type ReactionsCreateForIssueCommentRequestOptions = { method: "POST"; - url: Url; + url: "/repos/:owner/:repo/issues/comments/:comment_id/reactions"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReactionsCreateForIssueCommentResponseDataUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReactionsCreateForIssueCommentResponseData = { + id: number; + node_id: string; + user: ReactionsCreateForIssueCommentResponseDataUser; + content: string; + created_at: string; +}; + +type ReactionsDeleteForIssueCommentEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * comment_id parameter + */ + comment_id: number; + /** + * reaction_id parameter + */ + reaction_id: number; +} & RequiredPreview<"squirrel-girl">; + +type ReactionsDeleteForIssueCommentRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/issues/comments/:comment_id/reactions/:reaction_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; + type IssuesListEventsForRepoEndpoint = { /** * owner parameter @@ -8524,12 +26350,187 @@ type IssuesListEventsForRepoEndpoint = { */ page?: number; }; + type IssuesListEventsForRepoRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/issues/events"; headers: RequestHeaders; request: RequestRequestOptions; }; +type IssuesListEventsForRepoResponseDataItemIssuePullRequest = { + url: string; + html_url: string; + diff_url: string; + patch_url: string; +}; +type IssuesListEventsForRepoResponseDataItemIssueMilestoneCreator = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type IssuesListEventsForRepoResponseDataItemIssueMilestone = { + url: string; + html_url: string; + labels_url: string; + id: number; + node_id: string; + number: number; + state: string; + title: string; + description: string; + creator: IssuesListEventsForRepoResponseDataItemIssueMilestoneCreator; + open_issues: number; + closed_issues: number; + created_at: string; + updated_at: string; + closed_at: string; + due_on: string; +}; +type IssuesListEventsForRepoResponseDataItemIssueAssigneesItem = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type IssuesListEventsForRepoResponseDataItemIssueAssignee = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type IssuesListEventsForRepoResponseDataItemIssueLabelsItem = { + id: number; + node_id: string; + url: string; + name: string; + description: string; + color: string; + default: boolean; +}; +type IssuesListEventsForRepoResponseDataItemIssueUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type IssuesListEventsForRepoResponseDataItemIssue = { + id: number; + node_id: string; + url: string; + repository_url: string; + labels_url: string; + comments_url: string; + events_url: string; + html_url: string; + number: number; + state: string; + title: string; + body: string; + user: IssuesListEventsForRepoResponseDataItemIssueUser; + labels: Array; + assignee: IssuesListEventsForRepoResponseDataItemIssueAssignee; + assignees: Array; + milestone: IssuesListEventsForRepoResponseDataItemIssueMilestone; + locked: boolean; + active_lock_reason: string; + comments: number; + pull_request: IssuesListEventsForRepoResponseDataItemIssuePullRequest; + closed_at: null; + created_at: string; + updated_at: string; +}; +type IssuesListEventsForRepoResponseDataItemActor = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type IssuesListEventsForRepoResponseDataItem = { + id: number; + node_id: string; + url: string; + actor: IssuesListEventsForRepoResponseDataItemActor; + event: string; + commit_id: string; + commit_url: string; + created_at: string; + issue: IssuesListEventsForRepoResponseDataItemIssue; +}; +type IssuesListEventsForRepoResponseData = Array< + IssuesListEventsForRepoResponseDataItem +>; + type IssuesGetEventEndpoint = { /** * owner parameter @@ -8544,12 +26545,184 @@ type IssuesGetEventEndpoint = { */ event_id: number; }; + type IssuesGetEventRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/issues/events/:event_id"; headers: RequestHeaders; request: RequestRequestOptions; }; +type IssuesGetEventResponseDataIssuePullRequest = { + url: string; + html_url: string; + diff_url: string; + patch_url: string; +}; +type IssuesGetEventResponseDataIssueMilestoneCreator = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type IssuesGetEventResponseDataIssueMilestone = { + url: string; + html_url: string; + labels_url: string; + id: number; + node_id: string; + number: number; + state: string; + title: string; + description: string; + creator: IssuesGetEventResponseDataIssueMilestoneCreator; + open_issues: number; + closed_issues: number; + created_at: string; + updated_at: string; + closed_at: string; + due_on: string; +}; +type IssuesGetEventResponseDataIssueAssigneesItem = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type IssuesGetEventResponseDataIssueAssignee = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type IssuesGetEventResponseDataIssueLabelsItem = { + id: number; + node_id: string; + url: string; + name: string; + description: string; + color: string; + default: boolean; +}; +type IssuesGetEventResponseDataIssueUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type IssuesGetEventResponseDataIssue = { + id: number; + node_id: string; + url: string; + repository_url: string; + labels_url: string; + comments_url: string; + events_url: string; + html_url: string; + number: number; + state: string; + title: string; + body: string; + user: IssuesGetEventResponseDataIssueUser; + labels: Array; + assignee: IssuesGetEventResponseDataIssueAssignee; + assignees: Array; + milestone: IssuesGetEventResponseDataIssueMilestone; + locked: boolean; + active_lock_reason: string; + comments: number; + pull_request: IssuesGetEventResponseDataIssuePullRequest; + closed_at: null; + created_at: string; + updated_at: string; +}; +type IssuesGetEventResponseDataActor = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type IssuesGetEventResponseData = { + id: number; + node_id: string; + url: string; + actor: IssuesGetEventResponseDataActor; + event: string; + commit_id: string; + commit_url: string; + created_at: string; + issue: IssuesGetEventResponseDataIssue; +}; + type IssuesGetEndpoint = { /** * owner parameter @@ -8564,12 +26737,174 @@ type IssuesGetEndpoint = { */ issue_number: number; }; + type IssuesGetRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/issues/:issue_number"; headers: RequestHeaders; request: RequestRequestOptions; }; +type IssuesGetResponseDataClosedBy = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type IssuesGetResponseDataPullRequest = { + url: string; + html_url: string; + diff_url: string; + patch_url: string; +}; +type IssuesGetResponseDataMilestoneCreator = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type IssuesGetResponseDataMilestone = { + url: string; + html_url: string; + labels_url: string; + id: number; + node_id: string; + number: number; + state: string; + title: string; + description: string; + creator: IssuesGetResponseDataMilestoneCreator; + open_issues: number; + closed_issues: number; + created_at: string; + updated_at: string; + closed_at: string; + due_on: string; +}; +type IssuesGetResponseDataAssigneesItem = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type IssuesGetResponseDataAssignee = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type IssuesGetResponseDataLabelsItem = { + id: number; + node_id: string; + url: string; + name: string; + description: string; + color: string; + default: boolean; +}; +type IssuesGetResponseDataUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type IssuesGetResponseData = { + id: number; + node_id: string; + url: string; + repository_url: string; + labels_url: string; + comments_url: string; + events_url: string; + html_url: string; + number: number; + state: string; + title: string; + body: string; + user: IssuesGetResponseDataUser; + labels: Array; + assignee: IssuesGetResponseDataAssignee; + assignees: Array; + milestone: IssuesGetResponseDataMilestone; + locked: boolean; + active_lock_reason: string; + comments: number; + pull_request: IssuesGetResponseDataPullRequest; + closed_at: null; + created_at: string; + updated_at: string; + closed_by: IssuesGetResponseDataClosedBy; +}; + type IssuesUpdateEndpoint = { /** * owner parameter @@ -8612,12 +26947,174 @@ type IssuesUpdateEndpoint = { */ assignees?: string[]; }; + type IssuesUpdateRequestOptions = { method: "PATCH"; - url: Url; + url: "/repos/:owner/:repo/issues/:issue_number"; headers: RequestHeaders; request: RequestRequestOptions; }; +type IssuesUpdateResponseDataClosedBy = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type IssuesUpdateResponseDataPullRequest = { + url: string; + html_url: string; + diff_url: string; + patch_url: string; +}; +type IssuesUpdateResponseDataMilestoneCreator = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type IssuesUpdateResponseDataMilestone = { + url: string; + html_url: string; + labels_url: string; + id: number; + node_id: string; + number: number; + state: string; + title: string; + description: string; + creator: IssuesUpdateResponseDataMilestoneCreator; + open_issues: number; + closed_issues: number; + created_at: string; + updated_at: string; + closed_at: string; + due_on: string; +}; +type IssuesUpdateResponseDataAssigneesItem = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type IssuesUpdateResponseDataAssignee = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type IssuesUpdateResponseDataLabelsItem = { + id: number; + node_id: string; + url: string; + name: string; + description: string; + color: string; + default: boolean; +}; +type IssuesUpdateResponseDataUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type IssuesUpdateResponseData = { + id: number; + node_id: string; + url: string; + repository_url: string; + labels_url: string; + comments_url: string; + events_url: string; + html_url: string; + number: number; + state: string; + title: string; + body: string; + user: IssuesUpdateResponseDataUser; + labels: Array; + assignee: IssuesUpdateResponseDataAssignee; + assignees: Array; + milestone: IssuesUpdateResponseDataMilestone; + locked: boolean; + active_lock_reason: string; + comments: number; + pull_request: IssuesUpdateResponseDataPullRequest; + closed_at: null; + created_at: string; + updated_at: string; + closed_by: IssuesUpdateResponseDataClosedBy; +}; + type IssuesAddAssigneesEndpoint = { /** * owner parameter @@ -8636,12 +27133,153 @@ type IssuesAddAssigneesEndpoint = { */ assignees?: string[]; }; + type IssuesAddAssigneesRequestOptions = { method: "POST"; - url: Url; + url: "/repos/:owner/:repo/issues/:issue_number/assignees"; headers: RequestHeaders; request: RequestRequestOptions; }; +type IssuesAddAssigneesResponseDataPullRequest = { + url: string; + html_url: string; + diff_url: string; + patch_url: string; +}; +type IssuesAddAssigneesResponseDataMilestoneCreator = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type IssuesAddAssigneesResponseDataMilestone = { + url: string; + html_url: string; + labels_url: string; + id: number; + node_id: string; + number: number; + state: string; + title: string; + description: string; + creator: IssuesAddAssigneesResponseDataMilestoneCreator; + open_issues: number; + closed_issues: number; + created_at: string; + updated_at: string; + closed_at: string; + due_on: string; +}; +type IssuesAddAssigneesResponseDataAssigneesItem = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type IssuesAddAssigneesResponseDataAssignee = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type IssuesAddAssigneesResponseDataLabelsItem = { + id: number; + node_id: string; + url: string; + name: string; + description: string; + color: string; + default: boolean; +}; +type IssuesAddAssigneesResponseDataUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type IssuesAddAssigneesResponseData = { + id: number; + node_id: string; + url: string; + repository_url: string; + labels_url: string; + comments_url: string; + events_url: string; + html_url: string; + number: number; + state: string; + title: string; + body: string; + user: IssuesAddAssigneesResponseDataUser; + labels: Array; + assignee: IssuesAddAssigneesResponseDataAssignee; + assignees: Array; + milestone: IssuesAddAssigneesResponseDataMilestone; + locked: boolean; + active_lock_reason: string; + comments: number; + pull_request: IssuesAddAssigneesResponseDataPullRequest; + closed_at: null; + created_at: string; + updated_at: string; +}; + type IssuesRemoveAssigneesEndpoint = { /** * owner parameter @@ -8660,12 +27298,153 @@ type IssuesRemoveAssigneesEndpoint = { */ assignees?: string[]; }; + type IssuesRemoveAssigneesRequestOptions = { method: "DELETE"; - url: Url; + url: "/repos/:owner/:repo/issues/:issue_number/assignees"; headers: RequestHeaders; request: RequestRequestOptions; }; +type IssuesRemoveAssigneesResponseDataPullRequest = { + url: string; + html_url: string; + diff_url: string; + patch_url: string; +}; +type IssuesRemoveAssigneesResponseDataMilestoneCreator = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type IssuesRemoveAssigneesResponseDataMilestone = { + url: string; + html_url: string; + labels_url: string; + id: number; + node_id: string; + number: number; + state: string; + title: string; + description: string; + creator: IssuesRemoveAssigneesResponseDataMilestoneCreator; + open_issues: number; + closed_issues: number; + created_at: string; + updated_at: string; + closed_at: string; + due_on: string; +}; +type IssuesRemoveAssigneesResponseDataAssigneesItem = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type IssuesRemoveAssigneesResponseDataAssignee = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type IssuesRemoveAssigneesResponseDataLabelsItem = { + id: number; + node_id: string; + url: string; + name: string; + description: string; + color: string; + default: boolean; +}; +type IssuesRemoveAssigneesResponseDataUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type IssuesRemoveAssigneesResponseData = { + id: number; + node_id: string; + url: string; + repository_url: string; + labels_url: string; + comments_url: string; + events_url: string; + html_url: string; + number: number; + state: string; + title: string; + body: string; + user: IssuesRemoveAssigneesResponseDataUser; + labels: Array; + assignee: IssuesRemoveAssigneesResponseDataAssignee; + assignees: Array; + milestone: IssuesRemoveAssigneesResponseDataMilestone; + locked: boolean; + active_lock_reason: string; + comments: number; + pull_request: IssuesRemoveAssigneesResponseDataPullRequest; + closed_at: null; + created_at: string; + updated_at: string; +}; + type IssuesListCommentsEndpoint = { /** * owner parameter @@ -8692,12 +27471,45 @@ type IssuesListCommentsEndpoint = { */ page?: number; }; + type IssuesListCommentsRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/issues/:issue_number/comments"; headers: RequestHeaders; request: RequestRequestOptions; }; +type IssuesListCommentsResponseDataItemUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type IssuesListCommentsResponseDataItem = { + id: number; + node_id: string; + url: string; + html_url: string; + body: string; + user: IssuesListCommentsResponseDataItemUser; + created_at: string; + updated_at: string; +}; +type IssuesListCommentsResponseData = Array; + type IssuesCreateCommentEndpoint = { /** * owner parameter @@ -8716,12 +27528,44 @@ type IssuesCreateCommentEndpoint = { */ body: string; }; + type IssuesCreateCommentRequestOptions = { method: "POST"; - url: Url; + url: "/repos/:owner/:repo/issues/:issue_number/comments"; headers: RequestHeaders; request: RequestRequestOptions; }; +type IssuesCreateCommentResponseDataUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type IssuesCreateCommentResponseData = { + id: number; + node_id: string; + url: string; + html_url: string; + body: string; + user: IssuesCreateCommentResponseDataUser; + created_at: string; + updated_at: string; +}; + type IssuesListEventsEndpoint = { /** * owner parameter @@ -8744,12 +27588,45 @@ type IssuesListEventsEndpoint = { */ page?: number; }; + type IssuesListEventsRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/issues/:issue_number/events"; headers: RequestHeaders; request: RequestRequestOptions; }; +type IssuesListEventsResponseDataItemActor = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type IssuesListEventsResponseDataItem = { + id: number; + node_id: string; + url: string; + actor: IssuesListEventsResponseDataItemActor; + event: string; + commit_id: string; + commit_url: string; + created_at: string; +}; +type IssuesListEventsResponseData = Array; + type IssuesListLabelsOnIssueEndpoint = { /** * owner parameter @@ -8772,12 +27649,26 @@ type IssuesListLabelsOnIssueEndpoint = { */ page?: number; }; + type IssuesListLabelsOnIssueRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/issues/:issue_number/labels"; headers: RequestHeaders; request: RequestRequestOptions; }; +type IssuesListLabelsOnIssueResponseDataItem = { + id: number; + node_id: string; + url: string; + name: string; + description: string; + color: string; + default: boolean; +}; +type IssuesListLabelsOnIssueResponseData = Array< + IssuesListLabelsOnIssueResponseDataItem +>; + type IssuesAddLabelsEndpoint = { /** * owner parameter @@ -8796,13 +27687,25 @@ type IssuesAddLabelsEndpoint = { */ labels: string[]; }; + type IssuesAddLabelsRequestOptions = { method: "POST"; - url: Url; + url: "/repos/:owner/:repo/issues/:issue_number/labels"; headers: RequestHeaders; request: RequestRequestOptions; }; -type IssuesReplaceLabelsEndpoint = { +type IssuesAddLabelsResponseDataItem = { + id: number; + node_id: string; + url: string; + name: string; + description: string; + color: string; + default: boolean; +}; +type IssuesAddLabelsResponseData = Array; + +type IssuesReplaceAllLabelsEndpoint = { /** * owner parameter */ @@ -8820,13 +27723,27 @@ type IssuesReplaceLabelsEndpoint = { */ labels?: string[]; }; -type IssuesReplaceLabelsRequestOptions = { + +type IssuesReplaceAllLabelsRequestOptions = { method: "PUT"; - url: Url; + url: "/repos/:owner/:repo/issues/:issue_number/labels"; headers: RequestHeaders; request: RequestRequestOptions; }; -type IssuesRemoveLabelsEndpoint = { +type IssuesReplaceAllLabelsResponseDataItem = { + id: number; + node_id: string; + url: string; + name: string; + description: string; + color: string; + default: boolean; +}; +type IssuesReplaceAllLabelsResponseData = Array< + IssuesReplaceAllLabelsResponseDataItem +>; + +type IssuesRemoveAllLabelsEndpoint = { /** * owner parameter */ @@ -8840,12 +27757,14 @@ type IssuesRemoveLabelsEndpoint = { */ issue_number: number; }; -type IssuesRemoveLabelsRequestOptions = { + +type IssuesRemoveAllLabelsRequestOptions = { method: "DELETE"; - url: Url; + url: "/repos/:owner/:repo/issues/:issue_number/labels"; headers: RequestHeaders; request: RequestRequestOptions; }; + type IssuesRemoveLabelEndpoint = { /** * owner parameter @@ -8864,12 +27783,24 @@ type IssuesRemoveLabelEndpoint = { */ name: string; }; + type IssuesRemoveLabelRequestOptions = { method: "DELETE"; - url: Url; + url: "/repos/:owner/:repo/issues/:issue_number/labels/:name"; headers: RequestHeaders; request: RequestRequestOptions; }; +type IssuesRemoveLabelResponseDataItem = { + id: number; + node_id: string; + url: string; + name: string; + description: string; + color: string; + default: boolean; +}; +type IssuesRemoveLabelResponseData = Array; + type IssuesLockEndpoint = { /** * owner parameter @@ -8892,12 +27823,14 @@ type IssuesLockEndpoint = { */ lock_reason?: "off-topic" | "too heated" | "resolved" | "spam"; }; + type IssuesLockRequestOptions = { method: "PUT"; - url: Url; + url: "/repos/:owner/:repo/issues/:issue_number/lock"; headers: RequestHeaders; request: RequestRequestOptions; }; + type IssuesUnlockEndpoint = { /** * owner parameter @@ -8912,12 +27845,14 @@ type IssuesUnlockEndpoint = { */ issue_number: number; }; + type IssuesUnlockRequestOptions = { method: "DELETE"; - url: Url; + url: "/repos/:owner/:repo/issues/:issue_number/lock"; headers: RequestHeaders; request: RequestRequestOptions; }; + type ReactionsListForIssueEndpoint = { /** * owner parameter @@ -8951,13 +27886,45 @@ type ReactionsListForIssueEndpoint = { * Page number of the results to fetch. */ page?: number; -}; +} & RequiredPreview<"squirrel-girl">; + type ReactionsListForIssueRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/issues/:issue_number/reactions"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReactionsListForIssueResponseDataItemUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReactionsListForIssueResponseDataItem = { + id: number; + node_id: string; + user: ReactionsListForIssueResponseDataItemUser; + content: string; + created_at: string; +}; +type ReactionsListForIssueResponseData = Array< + ReactionsListForIssueResponseDataItem +>; + type ReactionsCreateForIssueEndpoint = { /** * owner parameter @@ -8983,13 +27950,68 @@ type ReactionsCreateForIssueEndpoint = { | "hooray" | "rocket" | "eyes"; -}; +} & RequiredPreview<"squirrel-girl">; + type ReactionsCreateForIssueRequestOptions = { method: "POST"; - url: Url; + url: "/repos/:owner/:repo/issues/:issue_number/reactions"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReactionsCreateForIssueResponseDataUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReactionsCreateForIssueResponseData = { + id: number; + node_id: string; + user: ReactionsCreateForIssueResponseDataUser; + content: string; + created_at: string; +}; + +type ReactionsDeleteForIssueEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * issue_number parameter + */ + issue_number: number; + /** + * reaction_id parameter + */ + reaction_id: number; +} & RequiredPreview<"squirrel-girl">; + +type ReactionsDeleteForIssueRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/issues/:issue_number/reactions/:reaction_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; + type IssuesListEventsForTimelineEndpoint = { /** * owner parameter @@ -9011,13 +28033,48 @@ type IssuesListEventsForTimelineEndpoint = { * Page number of the results to fetch. */ page?: number; -}; +} & RequiredPreview<"mockingbird">; + type IssuesListEventsForTimelineRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/issues/:issue_number/timeline"; headers: RequestHeaders; request: RequestRequestOptions; }; +type IssuesListEventsForTimelineResponseDataItemActor = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type IssuesListEventsForTimelineResponseDataItem = { + id: number; + node_id: string; + url: string; + actor: IssuesListEventsForTimelineResponseDataItemActor; + event: string; + commit_id: string; + commit_url: string; + created_at: string; +}; +type IssuesListEventsForTimelineResponseData = Array< + IssuesListEventsForTimelineResponseDataItem +>; + type ReposListDeployKeysEndpoint = { /** * owner parameter @@ -9036,12 +28093,26 @@ type ReposListDeployKeysEndpoint = { */ page?: number; }; + type ReposListDeployKeysRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/keys"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposListDeployKeysResponseDataItem = { + id: number; + key: string; + url: string; + title: string; + verified: boolean; + created_at: string; + read_only: boolean; +}; +type ReposListDeployKeysResponseData = Array< + ReposListDeployKeysResponseDataItem +>; + type ReposAddDeployKeyEndpoint = { /** * owner parameter @@ -9066,12 +28137,23 @@ type ReposAddDeployKeyEndpoint = { */ read_only?: boolean; }; + type ReposAddDeployKeyRequestOptions = { method: "POST"; - url: Url; + url: "/repos/:owner/:repo/keys"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposAddDeployKeyResponseData = { + id: number; + key: string; + url: string; + title: string; + verified: boolean; + created_at: string; + read_only: boolean; +}; + type ReposGetDeployKeyEndpoint = { /** * owner parameter @@ -9086,12 +28168,23 @@ type ReposGetDeployKeyEndpoint = { */ key_id: number; }; + type ReposGetDeployKeyRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/keys/:key_id"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposGetDeployKeyResponseData = { + id: number; + key: string; + url: string; + title: string; + verified: boolean; + created_at: string; + read_only: boolean; +}; + type ReposRemoveDeployKeyEndpoint = { /** * owner parameter @@ -9106,12 +28199,14 @@ type ReposRemoveDeployKeyEndpoint = { */ key_id: number; }; + type ReposRemoveDeployKeyRequestOptions = { method: "DELETE"; - url: Url; + url: "/repos/:owner/:repo/keys/:key_id"; headers: RequestHeaders; request: RequestRequestOptions; }; + type IssuesListLabelsForRepoEndpoint = { /** * owner parameter @@ -9130,12 +28225,26 @@ type IssuesListLabelsForRepoEndpoint = { */ page?: number; }; + type IssuesListLabelsForRepoRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/labels"; headers: RequestHeaders; request: RequestRequestOptions; }; +type IssuesListLabelsForRepoResponseDataItem = { + id: number; + node_id: string; + url: string; + name: string; + description: string; + color: string; + default: boolean; +}; +type IssuesListLabelsForRepoResponseData = Array< + IssuesListLabelsForRepoResponseDataItem +>; + type IssuesCreateLabelEndpoint = { /** * owner parameter @@ -9158,12 +28267,23 @@ type IssuesCreateLabelEndpoint = { */ description?: string; }; + type IssuesCreateLabelRequestOptions = { method: "POST"; - url: Url; + url: "/repos/:owner/:repo/labels"; headers: RequestHeaders; request: RequestRequestOptions; }; +type IssuesCreateLabelResponseData = { + id: number; + node_id: string; + url: string; + name: string; + description: string; + color: string; + default: boolean; +}; + type IssuesGetLabelEndpoint = { /** * owner parameter @@ -9178,12 +28298,23 @@ type IssuesGetLabelEndpoint = { */ name: string; }; + type IssuesGetLabelRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/labels/:name"; headers: RequestHeaders; request: RequestRequestOptions; }; +type IssuesGetLabelResponseData = { + id: number; + node_id: string; + url: string; + name: string; + description: string; + color: string; + default: boolean; +}; + type IssuesUpdateLabelEndpoint = { /** * owner parameter @@ -9210,12 +28341,23 @@ type IssuesUpdateLabelEndpoint = { */ description?: string; }; + type IssuesUpdateLabelRequestOptions = { method: "PATCH"; - url: Url; + url: "/repos/:owner/:repo/labels/:name"; headers: RequestHeaders; request: RequestRequestOptions; }; +type IssuesUpdateLabelResponseData = { + id: number; + node_id: string; + url: string; + name: string; + description: string; + color: string; + default: boolean; +}; + type IssuesDeleteLabelEndpoint = { /** * owner parameter @@ -9230,12 +28372,14 @@ type IssuesDeleteLabelEndpoint = { */ name: string; }; + type IssuesDeleteLabelRequestOptions = { method: "DELETE"; - url: Url; + url: "/repos/:owner/:repo/labels/:name"; headers: RequestHeaders; request: RequestRequestOptions; }; + type ReposListLanguagesEndpoint = { /** * owner parameter @@ -9246,12 +28390,15 @@ type ReposListLanguagesEndpoint = { */ repo: string; }; + type ReposListLanguagesRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/languages"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposListLanguagesResponseData = { C: number; Python: number }; + type LicensesGetForRepoEndpoint = { /** * owner parameter @@ -9262,12 +28409,41 @@ type LicensesGetForRepoEndpoint = { */ repo: string; }; + type LicensesGetForRepoRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/license"; headers: RequestHeaders; request: RequestRequestOptions; }; +type LicensesGetForRepoResponseDataLicense = { + key: string; + name: string; + spdx_id: string; + url: string; + node_id: string; +}; +type LicensesGetForRepoResponseDataLinks = { + self: string; + git: string; + html: string; +}; +type LicensesGetForRepoResponseData = { + name: string; + path: string; + sha: string; + size: number; + url: string; + html_url: string; + git_url: string; + download_url: string; + type: string; + content: string; + encoding: string; + _links: LicensesGetForRepoResponseDataLinks; + license: LicensesGetForRepoResponseDataLicense; +}; + type ReposMergeEndpoint = { /** * owner parameter @@ -9290,12 +28466,92 @@ type ReposMergeEndpoint = { */ commit_message?: string; }; + type ReposMergeRequestOptions = { method: "POST"; - url: Url; + url: "/repos/:owner/:repo/merges"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposMergeResponseDataParentsItem = { sha: string; url: string }; +type ReposMergeResponseDataCommitter = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposMergeResponseDataAuthor = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposMergeResponseDataCommitVerification = { + verified: boolean; + reason: string; + signature: null; + payload: null; +}; +type ReposMergeResponseDataCommitTree = { sha: string; url: string }; +type ReposMergeResponseDataCommitCommitter = { + name: string; + date: string; + email: string; +}; +type ReposMergeResponseDataCommitAuthor = { + name: string; + date: string; + email: string; +}; +type ReposMergeResponseDataCommit = { + author: ReposMergeResponseDataCommitAuthor; + committer: ReposMergeResponseDataCommitCommitter; + message: string; + tree: ReposMergeResponseDataCommitTree; + url: string; + comment_count: number; + verification: ReposMergeResponseDataCommitVerification; +}; +type ReposMergeResponseData = { + sha: string; + node_id: string; + commit: ReposMergeResponseDataCommit; + url: string; + html_url: string; + comments_url: string; + author: ReposMergeResponseDataAuthor; + committer: ReposMergeResponseDataCommitter; + parents: Array; +}; + type IssuesListMilestonesForRepoEndpoint = { /** * owner parameter @@ -9326,12 +28582,55 @@ type IssuesListMilestonesForRepoEndpoint = { */ page?: number; }; + type IssuesListMilestonesForRepoRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/milestones"; headers: RequestHeaders; request: RequestRequestOptions; }; +type IssuesListMilestonesForRepoResponseDataItemCreator = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type IssuesListMilestonesForRepoResponseDataItem = { + url: string; + html_url: string; + labels_url: string; + id: number; + node_id: string; + number: number; + state: string; + title: string; + description: string; + creator: IssuesListMilestonesForRepoResponseDataItemCreator; + open_issues: number; + closed_issues: number; + created_at: string; + updated_at: string; + closed_at: string; + due_on: string; +}; +type IssuesListMilestonesForRepoResponseData = Array< + IssuesListMilestonesForRepoResponseDataItem +>; + type IssuesCreateMilestoneEndpoint = { /** * owner parameter @@ -9358,12 +28657,52 @@ type IssuesCreateMilestoneEndpoint = { */ due_on?: string; }; + type IssuesCreateMilestoneRequestOptions = { method: "POST"; - url: Url; + url: "/repos/:owner/:repo/milestones"; headers: RequestHeaders; request: RequestRequestOptions; }; +type IssuesCreateMilestoneResponseDataCreator = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type IssuesCreateMilestoneResponseData = { + url: string; + html_url: string; + labels_url: string; + id: number; + node_id: string; + number: number; + state: string; + title: string; + description: string; + creator: IssuesCreateMilestoneResponseDataCreator; + open_issues: number; + closed_issues: number; + created_at: string; + updated_at: string; + closed_at: string; + due_on: string; +}; + type IssuesGetMilestoneEndpoint = { /** * owner parameter @@ -9378,12 +28717,52 @@ type IssuesGetMilestoneEndpoint = { */ milestone_number: number; }; + type IssuesGetMilestoneRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/milestones/:milestone_number"; headers: RequestHeaders; request: RequestRequestOptions; }; +type IssuesGetMilestoneResponseDataCreator = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type IssuesGetMilestoneResponseData = { + url: string; + html_url: string; + labels_url: string; + id: number; + node_id: string; + number: number; + state: string; + title: string; + description: string; + creator: IssuesGetMilestoneResponseDataCreator; + open_issues: number; + closed_issues: number; + created_at: string; + updated_at: string; + closed_at: string; + due_on: string; +}; + type IssuesUpdateMilestoneEndpoint = { /** * owner parameter @@ -9414,12 +28793,52 @@ type IssuesUpdateMilestoneEndpoint = { */ due_on?: string; }; + type IssuesUpdateMilestoneRequestOptions = { method: "PATCH"; - url: Url; + url: "/repos/:owner/:repo/milestones/:milestone_number"; headers: RequestHeaders; request: RequestRequestOptions; }; +type IssuesUpdateMilestoneResponseDataCreator = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type IssuesUpdateMilestoneResponseData = { + url: string; + html_url: string; + labels_url: string; + id: number; + node_id: string; + number: number; + state: string; + title: string; + description: string; + creator: IssuesUpdateMilestoneResponseDataCreator; + open_issues: number; + closed_issues: number; + created_at: string; + updated_at: string; + closed_at: string; + due_on: string; +}; + type IssuesDeleteMilestoneEndpoint = { /** * owner parameter @@ -9434,12 +28853,14 @@ type IssuesDeleteMilestoneEndpoint = { */ milestone_number: number; }; + type IssuesDeleteMilestoneRequestOptions = { method: "DELETE"; - url: Url; + url: "/repos/:owner/:repo/milestones/:milestone_number"; headers: RequestHeaders; request: RequestRequestOptions; }; + type IssuesListLabelsForMilestoneEndpoint = { /** * owner parameter @@ -9462,13 +28883,27 @@ type IssuesListLabelsForMilestoneEndpoint = { */ page?: number; }; + type IssuesListLabelsForMilestoneRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/milestones/:milestone_number/labels"; headers: RequestHeaders; request: RequestRequestOptions; }; -type ActivityListNotificationsForRepoEndpoint = { +type IssuesListLabelsForMilestoneResponseDataItem = { + id: number; + node_id: string; + url: string; + name: string; + description: string; + color: string; + default: boolean; +}; +type IssuesListLabelsForMilestoneResponseData = Array< + IssuesListLabelsForMilestoneResponseDataItem +>; + +type ActivityListRepoNotificationsForAuthenticatedUserEndpoint = { /** * owner parameter */ @@ -9502,13 +28937,103 @@ type ActivityListNotificationsForRepoEndpoint = { */ page?: number; }; -type ActivityListNotificationsForRepoRequestOptions = { + +type ActivityListRepoNotificationsForAuthenticatedUserRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/notifications"; headers: RequestHeaders; request: RequestRequestOptions; }; -type ActivityMarkNotificationsAsReadForRepoEndpoint = { +type ActivityListRepoNotificationsForAuthenticatedUserResponseDataItemSubject = { + title: string; + url: string; + latest_comment_url: string; + type: string; +}; +type ActivityListRepoNotificationsForAuthenticatedUserResponseDataItemRepositoryOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ActivityListRepoNotificationsForAuthenticatedUserResponseDataItemRepository = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: ActivityListRepoNotificationsForAuthenticatedUserResponseDataItemRepositoryOwner; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; +}; +type ActivityListRepoNotificationsForAuthenticatedUserResponseDataItem = { + id: string; + repository: ActivityListRepoNotificationsForAuthenticatedUserResponseDataItemRepository; + subject: ActivityListRepoNotificationsForAuthenticatedUserResponseDataItemSubject; + reason: string; + unread: boolean; + updated_at: string; + last_read_at: string; + url: string; +}; +type ActivityListRepoNotificationsForAuthenticatedUserResponseData = Array< + ActivityListRepoNotificationsForAuthenticatedUserResponseDataItem +>; + +type ActivityMarkRepoNotificationsAsReadEndpoint = { /** * owner parameter */ @@ -9518,16 +29043,18 @@ type ActivityMarkNotificationsAsReadForRepoEndpoint = { */ repo: string; /** - * Describes the last point that notifications were checked. Anything updated since this time will not be updated. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp. + * Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp. */ last_read_at?: string; }; -type ActivityMarkNotificationsAsReadForRepoRequestOptions = { + +type ActivityMarkRepoNotificationsAsReadRequestOptions = { method: "PUT"; - url: Url; + url: "/repos/:owner/:repo/notifications"; headers: RequestHeaders; request: RequestRequestOptions; }; + type ReposGetPagesEndpoint = { /** * owner parameter @@ -9538,12 +29065,23 @@ type ReposGetPagesEndpoint = { */ repo: string; }; + type ReposGetPagesRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/pages"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposGetPagesResponseDataSource = { branch: string; directory: string }; +type ReposGetPagesResponseData = { + url: string; + status: string; + cname: string; + custom_404: boolean; + html_url: string; + source: ReposGetPagesResponseDataSource; +}; + type ReposEnablePagesSiteEndpoint = { /** * owner parameter @@ -9557,13 +29095,27 @@ type ReposEnablePagesSiteEndpoint = { * source parameter */ source?: ReposEnablePagesSiteParamsSource; -}; +} & RequiredPreview<"switcheroo">; + type ReposEnablePagesSiteRequestOptions = { method: "POST"; - url: Url; + url: "/repos/:owner/:repo/pages"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposEnablePagesSiteResponseDataSource = { + branch: string; + directory: string; +}; +type ReposEnablePagesSiteResponseData = { + url: string; + status: string; + cname: string; + custom_404: boolean; + html_url: string; + source: ReposEnablePagesSiteResponseDataSource; +}; + type ReposDisablePagesSiteEndpoint = { /** * owner parameter @@ -9573,13 +29125,15 @@ type ReposDisablePagesSiteEndpoint = { * repo parameter */ repo: string; -}; +} & RequiredPreview<"switcheroo">; + type ReposDisablePagesSiteRequestOptions = { method: "DELETE"; - url: Url; + url: "/repos/:owner/:repo/pages"; headers: RequestHeaders; request: RequestRequestOptions; }; + type ReposUpdateInformationAboutPagesSiteEndpoint = { /** * owner parameter @@ -9598,12 +29152,14 @@ type ReposUpdateInformationAboutPagesSiteEndpoint = { */ source?: '"gh-pages"' | '"master"' | '"master /docs"'; }; + type ReposUpdateInformationAboutPagesSiteRequestOptions = { method: "PUT"; - url: Url; + url: "/repos/:owner/:repo/pages"; headers: RequestHeaders; request: RequestRequestOptions; }; + type ReposRequestPageBuildEndpoint = { /** * owner parameter @@ -9614,12 +29170,15 @@ type ReposRequestPageBuildEndpoint = { */ repo: string; }; + type ReposRequestPageBuildRequestOptions = { method: "POST"; - url: Url; + url: "/repos/:owner/:repo/pages/builds"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposRequestPageBuildResponseData = { url: string; status: string }; + type ReposListPagesBuildsEndpoint = { /** * owner parameter @@ -9638,12 +29197,48 @@ type ReposListPagesBuildsEndpoint = { */ page?: number; }; + type ReposListPagesBuildsRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/pages/builds"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposListPagesBuildsResponseDataItemPusher = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposListPagesBuildsResponseDataItemError = { message: null }; +type ReposListPagesBuildsResponseDataItem = { + url: string; + status: string; + error: ReposListPagesBuildsResponseDataItemError; + pusher: ReposListPagesBuildsResponseDataItemPusher; + commit: string; + duration: number; + created_at: string; + updated_at: string; +}; +type ReposListPagesBuildsResponseData = Array< + ReposListPagesBuildsResponseDataItem +>; + type ReposGetLatestPagesBuildEndpoint = { /** * owner parameter @@ -9654,12 +29249,45 @@ type ReposGetLatestPagesBuildEndpoint = { */ repo: string; }; + type ReposGetLatestPagesBuildRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/pages/builds/latest"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposGetLatestPagesBuildResponseDataPusher = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposGetLatestPagesBuildResponseDataError = { message: null }; +type ReposGetLatestPagesBuildResponseData = { + url: string; + status: string; + error: ReposGetLatestPagesBuildResponseDataError; + pusher: ReposGetLatestPagesBuildResponseDataPusher; + commit: string; + duration: number; + created_at: string; + updated_at: string; +}; + type ReposGetPagesBuildEndpoint = { /** * owner parameter @@ -9674,12 +29302,45 @@ type ReposGetPagesBuildEndpoint = { */ build_id: number; }; + type ReposGetPagesBuildRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/pages/builds/:build_id"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposGetPagesBuildResponseDataPusher = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposGetPagesBuildResponseDataError = { message: null }; +type ReposGetPagesBuildResponseData = { + url: string; + status: string; + error: ReposGetPagesBuildResponseDataError; + pusher: ReposGetPagesBuildResponseDataPusher; + commit: string; + duration: number; + created_at: string; + updated_at: string; +}; + type ProjectsListForRepoEndpoint = { /** * owner parameter @@ -9701,13 +29362,53 @@ type ProjectsListForRepoEndpoint = { * Page number of the results to fetch. */ page?: number; -}; +} & RequiredPreview<"inertia">; + type ProjectsListForRepoRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/projects"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ProjectsListForRepoResponseDataItemCreator = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ProjectsListForRepoResponseDataItem = { + owner_url: string; + url: string; + html_url: string; + columns_url: string; + id: number; + node_id: string; + name: string; + body: string; + number: number; + state: string; + creator: ProjectsListForRepoResponseDataItemCreator; + created_at: string; + updated_at: string; +}; +type ProjectsListForRepoResponseData = Array< + ProjectsListForRepoResponseDataItem +>; + type ProjectsCreateForRepoEndpoint = { /** * owner parameter @@ -9725,13 +29426,50 @@ type ProjectsCreateForRepoEndpoint = { * The description of the project. */ body?: string; -}; +} & RequiredPreview<"inertia">; + type ProjectsCreateForRepoRequestOptions = { method: "POST"; - url: Url; + url: "/repos/:owner/:repo/projects"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ProjectsCreateForRepoResponseDataCreator = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ProjectsCreateForRepoResponseData = { + owner_url: string; + url: string; + html_url: string; + columns_url: string; + id: number; + node_id: string; + name: string; + body: string; + number: number; + state: string; + creator: ProjectsCreateForRepoResponseDataCreator; + created_at: string; + updated_at: string; +}; + type PullsListEndpoint = { /** * owner parameter @@ -9770,12 +29508,479 @@ type PullsListEndpoint = { */ page?: number; }; + type PullsListRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/pulls"; headers: RequestHeaders; request: RequestRequestOptions; }; +type PullsListResponseDataItemLinksStatuses = { href: string }; +type PullsListResponseDataItemLinksCommits = { href: string }; +type PullsListResponseDataItemLinksReviewComment = { href: string }; +type PullsListResponseDataItemLinksReviewComments = { href: string }; +type PullsListResponseDataItemLinksComments = { href: string }; +type PullsListResponseDataItemLinksIssue = { href: string }; +type PullsListResponseDataItemLinksHtml = { href: string }; +type PullsListResponseDataItemLinksSelf = { href: string }; +type PullsListResponseDataItemLinks = { + self: PullsListResponseDataItemLinksSelf; + html: PullsListResponseDataItemLinksHtml; + issue: PullsListResponseDataItemLinksIssue; + comments: PullsListResponseDataItemLinksComments; + review_comments: PullsListResponseDataItemLinksReviewComments; + review_comment: PullsListResponseDataItemLinksReviewComment; + commits: PullsListResponseDataItemLinksCommits; + statuses: PullsListResponseDataItemLinksStatuses; +}; +type PullsListResponseDataItemBaseRepoPermissions = { + admin: boolean; + push: boolean; + pull: boolean; +}; +type PullsListResponseDataItemBaseRepoOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type PullsListResponseDataItemBaseRepo = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: PullsListResponseDataItemBaseRepoOwner; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: null; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: Array; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: PullsListResponseDataItemBaseRepoPermissions; + allow_rebase_merge: boolean; + template_repository: null; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; +}; +type PullsListResponseDataItemBaseUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type PullsListResponseDataItemBase = { + label: string; + ref: string; + sha: string; + user: PullsListResponseDataItemBaseUser; + repo: PullsListResponseDataItemBaseRepo; +}; +type PullsListResponseDataItemHeadRepoPermissions = { + admin: boolean; + push: boolean; + pull: boolean; +}; +type PullsListResponseDataItemHeadRepoOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type PullsListResponseDataItemHeadRepo = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: PullsListResponseDataItemHeadRepoOwner; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: null; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: Array; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: PullsListResponseDataItemHeadRepoPermissions; + allow_rebase_merge: boolean; + template_repository: null; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; +}; +type PullsListResponseDataItemHeadUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type PullsListResponseDataItemHead = { + label: string; + ref: string; + sha: string; + user: PullsListResponseDataItemHeadUser; + repo: PullsListResponseDataItemHeadRepo; +}; +type PullsListResponseDataItemRequestedTeamsItem = { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: null; +}; +type PullsListResponseDataItemRequestedReviewersItem = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type PullsListResponseDataItemAssigneesItem = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type PullsListResponseDataItemAssignee = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type PullsListResponseDataItemMilestoneCreator = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type PullsListResponseDataItemMilestone = { + url: string; + html_url: string; + labels_url: string; + id: number; + node_id: string; + number: number; + state: string; + title: string; + description: string; + creator: PullsListResponseDataItemMilestoneCreator; + open_issues: number; + closed_issues: number; + created_at: string; + updated_at: string; + closed_at: string; + due_on: string; +}; +type PullsListResponseDataItemLabelsItem = { + id: number; + node_id: string; + url: string; + name: string; + description: string; + color: string; + default: boolean; +}; +type PullsListResponseDataItemUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type PullsListResponseDataItem = { + url: string; + id: number; + node_id: string; + html_url: string; + diff_url: string; + patch_url: string; + issue_url: string; + commits_url: string; + review_comments_url: string; + review_comment_url: string; + comments_url: string; + statuses_url: string; + number: number; + state: string; + locked: boolean; + title: string; + user: PullsListResponseDataItemUser; + body: string; + labels: Array; + milestone: PullsListResponseDataItemMilestone; + active_lock_reason: string; + created_at: string; + updated_at: string; + closed_at: string; + merged_at: string; + merge_commit_sha: string; + assignee: PullsListResponseDataItemAssignee; + assignees: Array; + requested_reviewers: Array; + requested_teams: Array; + head: PullsListResponseDataItemHead; + base: PullsListResponseDataItemBase; + _links: PullsListResponseDataItemLinks; + author_association: string; + draft: boolean; +}; +type PullsListResponseData = Array; + type PullsCreateEndpoint = { /** * owner parameter @@ -9810,12 +30015,510 @@ type PullsCreateEndpoint = { */ draft?: boolean; }; + type PullsCreateRequestOptions = { method: "POST"; - url: Url; + url: "/repos/:owner/:repo/pulls"; headers: RequestHeaders; request: RequestRequestOptions; }; +type PullsCreateResponseDataMergedBy = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type PullsCreateResponseDataLinksStatuses = { href: string }; +type PullsCreateResponseDataLinksCommits = { href: string }; +type PullsCreateResponseDataLinksReviewComment = { href: string }; +type PullsCreateResponseDataLinksReviewComments = { href: string }; +type PullsCreateResponseDataLinksComments = { href: string }; +type PullsCreateResponseDataLinksIssue = { href: string }; +type PullsCreateResponseDataLinksHtml = { href: string }; +type PullsCreateResponseDataLinksSelf = { href: string }; +type PullsCreateResponseDataLinks = { + self: PullsCreateResponseDataLinksSelf; + html: PullsCreateResponseDataLinksHtml; + issue: PullsCreateResponseDataLinksIssue; + comments: PullsCreateResponseDataLinksComments; + review_comments: PullsCreateResponseDataLinksReviewComments; + review_comment: PullsCreateResponseDataLinksReviewComment; + commits: PullsCreateResponseDataLinksCommits; + statuses: PullsCreateResponseDataLinksStatuses; +}; +type PullsCreateResponseDataBaseRepoPermissions = { + admin: boolean; + push: boolean; + pull: boolean; +}; +type PullsCreateResponseDataBaseRepoOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type PullsCreateResponseDataBaseRepo = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: PullsCreateResponseDataBaseRepoOwner; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: null; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: Array; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: PullsCreateResponseDataBaseRepoPermissions; + allow_rebase_merge: boolean; + template_repository: null; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; +}; +type PullsCreateResponseDataBaseUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type PullsCreateResponseDataBase = { + label: string; + ref: string; + sha: string; + user: PullsCreateResponseDataBaseUser; + repo: PullsCreateResponseDataBaseRepo; +}; +type PullsCreateResponseDataHeadRepoPermissions = { + admin: boolean; + push: boolean; + pull: boolean; +}; +type PullsCreateResponseDataHeadRepoOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type PullsCreateResponseDataHeadRepo = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: PullsCreateResponseDataHeadRepoOwner; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: null; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: Array; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: PullsCreateResponseDataHeadRepoPermissions; + allow_rebase_merge: boolean; + template_repository: null; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; +}; +type PullsCreateResponseDataHeadUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type PullsCreateResponseDataHead = { + label: string; + ref: string; + sha: string; + user: PullsCreateResponseDataHeadUser; + repo: PullsCreateResponseDataHeadRepo; +}; +type PullsCreateResponseDataRequestedTeamsItem = { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: null; +}; +type PullsCreateResponseDataRequestedReviewersItem = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type PullsCreateResponseDataAssigneesItem = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type PullsCreateResponseDataAssignee = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type PullsCreateResponseDataMilestoneCreator = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type PullsCreateResponseDataMilestone = { + url: string; + html_url: string; + labels_url: string; + id: number; + node_id: string; + number: number; + state: string; + title: string; + description: string; + creator: PullsCreateResponseDataMilestoneCreator; + open_issues: number; + closed_issues: number; + created_at: string; + updated_at: string; + closed_at: string; + due_on: string; +}; +type PullsCreateResponseDataLabelsItem = { + id: number; + node_id: string; + url: string; + name: string; + description: string; + color: string; + default: boolean; +}; +type PullsCreateResponseDataUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type PullsCreateResponseData = { + url: string; + id: number; + node_id: string; + html_url: string; + diff_url: string; + patch_url: string; + issue_url: string; + commits_url: string; + review_comments_url: string; + review_comment_url: string; + comments_url: string; + statuses_url: string; + number: number; + state: string; + locked: boolean; + title: string; + user: PullsCreateResponseDataUser; + body: string; + labels: Array; + milestone: PullsCreateResponseDataMilestone; + active_lock_reason: string; + created_at: string; + updated_at: string; + closed_at: string; + merged_at: string; + merge_commit_sha: string; + assignee: PullsCreateResponseDataAssignee; + assignees: Array; + requested_reviewers: Array; + requested_teams: Array; + head: PullsCreateResponseDataHead; + base: PullsCreateResponseDataBase; + _links: PullsCreateResponseDataLinks; + author_association: string; + draft: boolean; + merged: boolean; + mergeable: boolean; + rebaseable: boolean; + mergeable_state: string; + merged_by: PullsCreateResponseDataMergedBy; + comments: number; + review_comments: number; + maintainer_can_modify: boolean; + commits: number; + additions: number; + deletions: number; + changed_files: number; +}; + type PullsListCommentsForRepoEndpoint = { /** * owner parameter @@ -9846,12 +30549,74 @@ type PullsListCommentsForRepoEndpoint = { */ page?: number; }; + type PullsListCommentsForRepoRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/pulls/comments"; headers: RequestHeaders; request: RequestRequestOptions; }; +type PullsListCommentsForRepoResponseDataItemLinksPullRequest = { + href: string; +}; +type PullsListCommentsForRepoResponseDataItemLinksHtml = { href: string }; +type PullsListCommentsForRepoResponseDataItemLinksSelf = { href: string }; +type PullsListCommentsForRepoResponseDataItemLinks = { + self: PullsListCommentsForRepoResponseDataItemLinksSelf; + html: PullsListCommentsForRepoResponseDataItemLinksHtml; + pull_request: PullsListCommentsForRepoResponseDataItemLinksPullRequest; +}; +type PullsListCommentsForRepoResponseDataItemUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type PullsListCommentsForRepoResponseDataItem = { + url: string; + id: number; + node_id: string; + pull_request_review_id: number; + diff_hunk: string; + path: string; + position: number; + original_position: number; + commit_id: string; + original_commit_id: string; + in_reply_to_id: number; + user: PullsListCommentsForRepoResponseDataItemUser; + body: string; + created_at: string; + updated_at: string; + html_url: string; + pull_request_url: string; + author_association: string; + _links: PullsListCommentsForRepoResponseDataItemLinks; + start_line: number; + original_start_line: number; + start_side: string; + line: number; + original_line: number; + side: string; +}; +type PullsListCommentsForRepoResponseData = Array< + PullsListCommentsForRepoResponseDataItem +>; + type PullsGetCommentEndpoint = { /** * owner parameter @@ -9866,12 +30631,69 @@ type PullsGetCommentEndpoint = { */ comment_id: number; }; + type PullsGetCommentRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/pulls/comments/:comment_id"; headers: RequestHeaders; request: RequestRequestOptions; }; +type PullsGetCommentResponseDataLinksPullRequest = { href: string }; +type PullsGetCommentResponseDataLinksHtml = { href: string }; +type PullsGetCommentResponseDataLinksSelf = { href: string }; +type PullsGetCommentResponseDataLinks = { + self: PullsGetCommentResponseDataLinksSelf; + html: PullsGetCommentResponseDataLinksHtml; + pull_request: PullsGetCommentResponseDataLinksPullRequest; +}; +type PullsGetCommentResponseDataUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type PullsGetCommentResponseData = { + url: string; + id: number; + node_id: string; + pull_request_review_id: number; + diff_hunk: string; + path: string; + position: number; + original_position: number; + commit_id: string; + original_commit_id: string; + in_reply_to_id: number; + user: PullsGetCommentResponseDataUser; + body: string; + created_at: string; + updated_at: string; + html_url: string; + pull_request_url: string; + author_association: string; + _links: PullsGetCommentResponseDataLinks; + start_line: number; + original_start_line: number; + start_side: string; + line: number; + original_line: number; + side: string; +}; + type PullsUpdateCommentEndpoint = { /** * owner parameter @@ -9890,12 +30712,69 @@ type PullsUpdateCommentEndpoint = { */ body: string; }; + type PullsUpdateCommentRequestOptions = { method: "PATCH"; - url: Url; + url: "/repos/:owner/:repo/pulls/comments/:comment_id"; headers: RequestHeaders; request: RequestRequestOptions; }; +type PullsUpdateCommentResponseDataLinksPullRequest = { href: string }; +type PullsUpdateCommentResponseDataLinksHtml = { href: string }; +type PullsUpdateCommentResponseDataLinksSelf = { href: string }; +type PullsUpdateCommentResponseDataLinks = { + self: PullsUpdateCommentResponseDataLinksSelf; + html: PullsUpdateCommentResponseDataLinksHtml; + pull_request: PullsUpdateCommentResponseDataLinksPullRequest; +}; +type PullsUpdateCommentResponseDataUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type PullsUpdateCommentResponseData = { + url: string; + id: number; + node_id: string; + pull_request_review_id: number; + diff_hunk: string; + path: string; + position: number; + original_position: number; + commit_id: string; + original_commit_id: string; + in_reply_to_id: number; + user: PullsUpdateCommentResponseDataUser; + body: string; + created_at: string; + updated_at: string; + html_url: string; + pull_request_url: string; + author_association: string; + _links: PullsUpdateCommentResponseDataLinks; + start_line: number; + original_start_line: number; + start_side: string; + line: number; + original_line: number; + side: string; +}; + type PullsDeleteCommentEndpoint = { /** * owner parameter @@ -9910,12 +30789,14 @@ type PullsDeleteCommentEndpoint = { */ comment_id: number; }; + type PullsDeleteCommentRequestOptions = { method: "DELETE"; - url: Url; + url: "/repos/:owner/:repo/pulls/comments/:comment_id"; headers: RequestHeaders; request: RequestRequestOptions; }; + type ReactionsListForPullRequestReviewCommentEndpoint = { /** * owner parameter @@ -9949,13 +30830,45 @@ type ReactionsListForPullRequestReviewCommentEndpoint = { * Page number of the results to fetch. */ page?: number; -}; +} & RequiredPreview<"squirrel-girl">; + type ReactionsListForPullRequestReviewCommentRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/pulls/comments/:comment_id/reactions"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReactionsListForPullRequestReviewCommentResponseDataItemUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReactionsListForPullRequestReviewCommentResponseDataItem = { + id: number; + node_id: string; + user: ReactionsListForPullRequestReviewCommentResponseDataItemUser; + content: string; + created_at: string; +}; +type ReactionsListForPullRequestReviewCommentResponseData = Array< + ReactionsListForPullRequestReviewCommentResponseDataItem +>; + type ReactionsCreateForPullRequestReviewCommentEndpoint = { /** * owner parameter @@ -9981,13 +30894,68 @@ type ReactionsCreateForPullRequestReviewCommentEndpoint = { | "hooray" | "rocket" | "eyes"; -}; +} & RequiredPreview<"squirrel-girl">; + type ReactionsCreateForPullRequestReviewCommentRequestOptions = { method: "POST"; - url: Url; + url: "/repos/:owner/:repo/pulls/comments/:comment_id/reactions"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReactionsCreateForPullRequestReviewCommentResponseDataUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReactionsCreateForPullRequestReviewCommentResponseData = { + id: number; + node_id: string; + user: ReactionsCreateForPullRequestReviewCommentResponseDataUser; + content: string; + created_at: string; +}; + +type ReactionsDeleteForPullRequestCommentEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * comment_id parameter + */ + comment_id: number; + /** + * reaction_id parameter + */ + reaction_id: number; +} & RequiredPreview<"squirrel-girl">; + +type ReactionsDeleteForPullRequestCommentRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/pulls/comments/:comment_id/reactions/:reaction_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; + type PullsGetEndpoint = { /** * owner parameter @@ -10002,12 +30970,510 @@ type PullsGetEndpoint = { */ pull_number: number; }; + type PullsGetRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/pulls/:pull_number"; headers: RequestHeaders; request: RequestRequestOptions; }; +type PullsGetResponseDataMergedBy = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type PullsGetResponseDataLinksStatuses = { href: string }; +type PullsGetResponseDataLinksCommits = { href: string }; +type PullsGetResponseDataLinksReviewComment = { href: string }; +type PullsGetResponseDataLinksReviewComments = { href: string }; +type PullsGetResponseDataLinksComments = { href: string }; +type PullsGetResponseDataLinksIssue = { href: string }; +type PullsGetResponseDataLinksHtml = { href: string }; +type PullsGetResponseDataLinksSelf = { href: string }; +type PullsGetResponseDataLinks = { + self: PullsGetResponseDataLinksSelf; + html: PullsGetResponseDataLinksHtml; + issue: PullsGetResponseDataLinksIssue; + comments: PullsGetResponseDataLinksComments; + review_comments: PullsGetResponseDataLinksReviewComments; + review_comment: PullsGetResponseDataLinksReviewComment; + commits: PullsGetResponseDataLinksCommits; + statuses: PullsGetResponseDataLinksStatuses; +}; +type PullsGetResponseDataBaseRepoPermissions = { + admin: boolean; + push: boolean; + pull: boolean; +}; +type PullsGetResponseDataBaseRepoOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type PullsGetResponseDataBaseRepo = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: PullsGetResponseDataBaseRepoOwner; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: null; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: Array; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: PullsGetResponseDataBaseRepoPermissions; + allow_rebase_merge: boolean; + template_repository: null; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; +}; +type PullsGetResponseDataBaseUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type PullsGetResponseDataBase = { + label: string; + ref: string; + sha: string; + user: PullsGetResponseDataBaseUser; + repo: PullsGetResponseDataBaseRepo; +}; +type PullsGetResponseDataHeadRepoPermissions = { + admin: boolean; + push: boolean; + pull: boolean; +}; +type PullsGetResponseDataHeadRepoOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type PullsGetResponseDataHeadRepo = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: PullsGetResponseDataHeadRepoOwner; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: null; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: Array; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: PullsGetResponseDataHeadRepoPermissions; + allow_rebase_merge: boolean; + template_repository: null; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; +}; +type PullsGetResponseDataHeadUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type PullsGetResponseDataHead = { + label: string; + ref: string; + sha: string; + user: PullsGetResponseDataHeadUser; + repo: PullsGetResponseDataHeadRepo; +}; +type PullsGetResponseDataRequestedTeamsItem = { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: null; +}; +type PullsGetResponseDataRequestedReviewersItem = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type PullsGetResponseDataAssigneesItem = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type PullsGetResponseDataAssignee = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type PullsGetResponseDataMilestoneCreator = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type PullsGetResponseDataMilestone = { + url: string; + html_url: string; + labels_url: string; + id: number; + node_id: string; + number: number; + state: string; + title: string; + description: string; + creator: PullsGetResponseDataMilestoneCreator; + open_issues: number; + closed_issues: number; + created_at: string; + updated_at: string; + closed_at: string; + due_on: string; +}; +type PullsGetResponseDataLabelsItem = { + id: number; + node_id: string; + url: string; + name: string; + description: string; + color: string; + default: boolean; +}; +type PullsGetResponseDataUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type PullsGetResponseData = { + url: string; + id: number; + node_id: string; + html_url: string; + diff_url: string; + patch_url: string; + issue_url: string; + commits_url: string; + review_comments_url: string; + review_comment_url: string; + comments_url: string; + statuses_url: string; + number: number; + state: string; + locked: boolean; + title: string; + user: PullsGetResponseDataUser; + body: string; + labels: Array; + milestone: PullsGetResponseDataMilestone; + active_lock_reason: string; + created_at: string; + updated_at: string; + closed_at: string; + merged_at: string; + merge_commit_sha: string; + assignee: PullsGetResponseDataAssignee; + assignees: Array; + requested_reviewers: Array; + requested_teams: Array; + head: PullsGetResponseDataHead; + base: PullsGetResponseDataBase; + _links: PullsGetResponseDataLinks; + author_association: string; + draft: boolean; + merged: boolean; + mergeable: boolean; + rebaseable: boolean; + mergeable_state: string; + merged_by: PullsGetResponseDataMergedBy; + comments: number; + review_comments: number; + maintainer_can_modify: boolean; + commits: number; + additions: number; + deletions: number; + changed_files: number; +}; + type PullsUpdateEndpoint = { /** * owner parameter @@ -10042,12 +31508,510 @@ type PullsUpdateEndpoint = { */ maintainer_can_modify?: boolean; }; + type PullsUpdateRequestOptions = { method: "PATCH"; - url: Url; + url: "/repos/:owner/:repo/pulls/:pull_number"; headers: RequestHeaders; request: RequestRequestOptions; }; +type PullsUpdateResponseDataMergedBy = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type PullsUpdateResponseDataLinksStatuses = { href: string }; +type PullsUpdateResponseDataLinksCommits = { href: string }; +type PullsUpdateResponseDataLinksReviewComment = { href: string }; +type PullsUpdateResponseDataLinksReviewComments = { href: string }; +type PullsUpdateResponseDataLinksComments = { href: string }; +type PullsUpdateResponseDataLinksIssue = { href: string }; +type PullsUpdateResponseDataLinksHtml = { href: string }; +type PullsUpdateResponseDataLinksSelf = { href: string }; +type PullsUpdateResponseDataLinks = { + self: PullsUpdateResponseDataLinksSelf; + html: PullsUpdateResponseDataLinksHtml; + issue: PullsUpdateResponseDataLinksIssue; + comments: PullsUpdateResponseDataLinksComments; + review_comments: PullsUpdateResponseDataLinksReviewComments; + review_comment: PullsUpdateResponseDataLinksReviewComment; + commits: PullsUpdateResponseDataLinksCommits; + statuses: PullsUpdateResponseDataLinksStatuses; +}; +type PullsUpdateResponseDataBaseRepoPermissions = { + admin: boolean; + push: boolean; + pull: boolean; +}; +type PullsUpdateResponseDataBaseRepoOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type PullsUpdateResponseDataBaseRepo = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: PullsUpdateResponseDataBaseRepoOwner; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: null; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: Array; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: PullsUpdateResponseDataBaseRepoPermissions; + allow_rebase_merge: boolean; + template_repository: null; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; +}; +type PullsUpdateResponseDataBaseUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type PullsUpdateResponseDataBase = { + label: string; + ref: string; + sha: string; + user: PullsUpdateResponseDataBaseUser; + repo: PullsUpdateResponseDataBaseRepo; +}; +type PullsUpdateResponseDataHeadRepoPermissions = { + admin: boolean; + push: boolean; + pull: boolean; +}; +type PullsUpdateResponseDataHeadRepoOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type PullsUpdateResponseDataHeadRepo = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: PullsUpdateResponseDataHeadRepoOwner; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: null; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: Array; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: PullsUpdateResponseDataHeadRepoPermissions; + allow_rebase_merge: boolean; + template_repository: null; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; +}; +type PullsUpdateResponseDataHeadUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type PullsUpdateResponseDataHead = { + label: string; + ref: string; + sha: string; + user: PullsUpdateResponseDataHeadUser; + repo: PullsUpdateResponseDataHeadRepo; +}; +type PullsUpdateResponseDataRequestedTeamsItem = { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: null; +}; +type PullsUpdateResponseDataRequestedReviewersItem = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type PullsUpdateResponseDataAssigneesItem = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type PullsUpdateResponseDataAssignee = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type PullsUpdateResponseDataMilestoneCreator = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type PullsUpdateResponseDataMilestone = { + url: string; + html_url: string; + labels_url: string; + id: number; + node_id: string; + number: number; + state: string; + title: string; + description: string; + creator: PullsUpdateResponseDataMilestoneCreator; + open_issues: number; + closed_issues: number; + created_at: string; + updated_at: string; + closed_at: string; + due_on: string; +}; +type PullsUpdateResponseDataLabelsItem = { + id: number; + node_id: string; + url: string; + name: string; + description: string; + color: string; + default: boolean; +}; +type PullsUpdateResponseDataUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type PullsUpdateResponseData = { + url: string; + id: number; + node_id: string; + html_url: string; + diff_url: string; + patch_url: string; + issue_url: string; + commits_url: string; + review_comments_url: string; + review_comment_url: string; + comments_url: string; + statuses_url: string; + number: number; + state: string; + locked: boolean; + title: string; + user: PullsUpdateResponseDataUser; + body: string; + labels: Array; + milestone: PullsUpdateResponseDataMilestone; + active_lock_reason: string; + created_at: string; + updated_at: string; + closed_at: string; + merged_at: string; + merge_commit_sha: string; + assignee: PullsUpdateResponseDataAssignee; + assignees: Array; + requested_reviewers: Array; + requested_teams: Array; + head: PullsUpdateResponseDataHead; + base: PullsUpdateResponseDataBase; + _links: PullsUpdateResponseDataLinks; + author_association: string; + draft: boolean; + merged: boolean; + mergeable: boolean; + rebaseable: boolean; + mergeable_state: string; + merged_by: PullsUpdateResponseDataMergedBy; + comments: number; + review_comments: number; + maintainer_can_modify: boolean; + commits: number; + additions: number; + deletions: number; + changed_files: number; +}; + type PullsListCommentsEndpoint = { /** * owner parameter @@ -10082,12 +32046,70 @@ type PullsListCommentsEndpoint = { */ page?: number; }; + type PullsListCommentsRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/pulls/:pull_number/comments"; headers: RequestHeaders; request: RequestRequestOptions; }; +type PullsListCommentsResponseDataItemLinksPullRequest = { href: string }; +type PullsListCommentsResponseDataItemLinksHtml = { href: string }; +type PullsListCommentsResponseDataItemLinksSelf = { href: string }; +type PullsListCommentsResponseDataItemLinks = { + self: PullsListCommentsResponseDataItemLinksSelf; + html: PullsListCommentsResponseDataItemLinksHtml; + pull_request: PullsListCommentsResponseDataItemLinksPullRequest; +}; +type PullsListCommentsResponseDataItemUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type PullsListCommentsResponseDataItem = { + url: string; + id: number; + node_id: string; + pull_request_review_id: number; + diff_hunk: string; + path: string; + position: number; + original_position: number; + commit_id: string; + original_commit_id: string; + in_reply_to_id: number; + user: PullsListCommentsResponseDataItemUser; + body: string; + created_at: string; + updated_at: string; + html_url: string; + pull_request_url: string; + author_association: string; + _links: PullsListCommentsResponseDataItemLinks; + start_line: number; + original_start_line: number; + start_side: string; + line: number; + original_line: number; + side: string; +}; +type PullsListCommentsResponseData = Array; + type PullsCreateCommentEndpoint = { /** * owner parameter @@ -10134,64 +32156,69 @@ type PullsCreateCommentEndpoint = { */ start_side?: "LEFT" | "RIGHT" | "side"; }; + type PullsCreateCommentRequestOptions = { method: "POST"; - url: Url; + url: "/repos/:owner/:repo/pulls/:pull_number/comments"; headers: RequestHeaders; request: RequestRequestOptions; }; -type PullsCreateCommentReplyEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * pull_number parameter - */ - pull_number: number; - /** - * The text of the review comment. - */ - body: string; - /** - * The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the `position`. - */ - commit_id: string; - /** - * The relative path to the file that necessitates a comment. - */ +type PullsCreateCommentResponseDataLinksPullRequest = { href: string }; +type PullsCreateCommentResponseDataLinksHtml = { href: string }; +type PullsCreateCommentResponseDataLinksSelf = { href: string }; +type PullsCreateCommentResponseDataLinks = { + self: PullsCreateCommentResponseDataLinksSelf; + html: PullsCreateCommentResponseDataLinksHtml; + pull_request: PullsCreateCommentResponseDataLinksPullRequest; +}; +type PullsCreateCommentResponseDataUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type PullsCreateCommentResponseData = { + url: string; + id: number; + node_id: string; + pull_request_review_id: number; + diff_hunk: string; path: string; - /** - * **Required without `comfort-fade` preview**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above. - */ - position?: number; - /** - * **Required with `comfort-fade` preview**. In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see "[Diff view options](https://help.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)" in the GitHub Help documentation. - */ - side?: "LEFT" | "RIGHT"; - /** - * **Required with `comfort-fade` preview**. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to. - */ - line?: number; - /** - * **Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see "[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. - */ - start_line?: number; - /** - * **Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see "[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. See `side` in this table for additional context. - */ - start_side?: "LEFT" | "RIGHT" | "side"; -}; -type PullsCreateCommentReplyRequestOptions = { - method: "POST"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; + position: number; + original_position: number; + commit_id: string; + original_commit_id: string; + in_reply_to_id: number; + user: PullsCreateCommentResponseDataUser; + body: string; + created_at: string; + updated_at: string; + html_url: string; + pull_request_url: string; + author_association: string; + _links: PullsCreateCommentResponseDataLinks; + start_line: number; + original_start_line: number; + start_side: string; + line: number; + original_line: number; + side: string; }; + type PullsCreateReviewCommentReplyEndpoint = { /** * owner parameter @@ -10214,12 +32241,64 @@ type PullsCreateReviewCommentReplyEndpoint = { */ body: string; }; + type PullsCreateReviewCommentReplyRequestOptions = { method: "POST"; - url: Url; + url: "/repos/:owner/:repo/pulls/:pull_number/comments/:comment_id/replies"; headers: RequestHeaders; request: RequestRequestOptions; }; +type PullsCreateReviewCommentReplyResponseDataLinksPullRequest = { + href: string; +}; +type PullsCreateReviewCommentReplyResponseDataLinksHtml = { href: string }; +type PullsCreateReviewCommentReplyResponseDataLinksSelf = { href: string }; +type PullsCreateReviewCommentReplyResponseDataLinks = { + self: PullsCreateReviewCommentReplyResponseDataLinksSelf; + html: PullsCreateReviewCommentReplyResponseDataLinksHtml; + pull_request: PullsCreateReviewCommentReplyResponseDataLinksPullRequest; +}; +type PullsCreateReviewCommentReplyResponseDataUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type PullsCreateReviewCommentReplyResponseData = { + url: string; + pull_request_review_id: number; + id: number; + node_id: string; + diff_hunk: string; + path: string; + position: number; + original_position: number; + commit_id: string; + original_commit_id: string; + user: PullsCreateReviewCommentReplyResponseDataUser; + body: string; + created_at: string; + updated_at: string; + html_url: string; + pull_request_url: string; + author_association: string; + _links: PullsCreateReviewCommentReplyResponseDataLinks; +}; + type PullsListCommitsEndpoint = { /** * owner parameter @@ -10242,12 +32321,93 @@ type PullsListCommitsEndpoint = { */ page?: number; }; + type PullsListCommitsRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/pulls/:pull_number/commits"; headers: RequestHeaders; request: RequestRequestOptions; }; +type PullsListCommitsResponseDataItemParentsItem = { url: string; sha: string }; +type PullsListCommitsResponseDataItemCommitter = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type PullsListCommitsResponseDataItemAuthor = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type PullsListCommitsResponseDataItemCommitVerification = { + verified: boolean; + reason: string; + signature: null; + payload: null; +}; +type PullsListCommitsResponseDataItemCommitTree = { url: string; sha: string }; +type PullsListCommitsResponseDataItemCommitCommitter = { + name: string; + email: string; + date: string; +}; +type PullsListCommitsResponseDataItemCommitAuthor = { + name: string; + email: string; + date: string; +}; +type PullsListCommitsResponseDataItemCommit = { + url: string; + author: PullsListCommitsResponseDataItemCommitAuthor; + committer: PullsListCommitsResponseDataItemCommitCommitter; + message: string; + tree: PullsListCommitsResponseDataItemCommitTree; + comment_count: number; + verification: PullsListCommitsResponseDataItemCommitVerification; +}; +type PullsListCommitsResponseDataItem = { + url: string; + sha: string; + node_id: string; + html_url: string; + comments_url: string; + commit: PullsListCommitsResponseDataItemCommit; + author: PullsListCommitsResponseDataItemAuthor; + committer: PullsListCommitsResponseDataItemCommitter; + parents: Array; +}; +type PullsListCommitsResponseData = Array; + type PullsListFilesEndpoint = { /** * owner parameter @@ -10270,12 +32430,27 @@ type PullsListFilesEndpoint = { */ page?: number; }; + type PullsListFilesRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/pulls/:pull_number/files"; headers: RequestHeaders; request: RequestRequestOptions; }; +type PullsListFilesResponseDataItem = { + sha: string; + filename: string; + status: string; + additions: number; + deletions: number; + changes: number; + blob_url: string; + raw_url: string; + contents_url: string; + patch: string; +}; +type PullsListFilesResponseData = Array; + type PullsCheckIfMergedEndpoint = { /** * owner parameter @@ -10290,12 +32465,14 @@ type PullsCheckIfMergedEndpoint = { */ pull_number: number; }; + type PullsCheckIfMergedRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/pulls/:pull_number/merge"; headers: RequestHeaders; request: RequestRequestOptions; }; + type PullsMergeEndpoint = { /** * owner parameter @@ -10326,12 +32503,15 @@ type PullsMergeEndpoint = { */ merge_method?: "merge" | "squash" | "rebase"; }; + type PullsMergeRequestOptions = { method: "PUT"; - url: Url; + url: "/repos/:owner/:repo/pulls/:pull_number/merge"; headers: RequestHeaders; request: RequestRequestOptions; }; +type PullsMergeResponseData = { sha: string; merged: boolean; message: string }; + type PullsListReviewRequestsEndpoint = { /** * owner parameter @@ -10354,12 +32534,52 @@ type PullsListReviewRequestsEndpoint = { */ page?: number; }; + type PullsListReviewRequestsRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/pulls/:pull_number/requested_reviewers"; headers: RequestHeaders; request: RequestRequestOptions; }; +type PullsListReviewRequestsResponseDataTeamsItem = { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: null; +}; +type PullsListReviewRequestsResponseDataUsersItem = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type PullsListReviewRequestsResponseData = { + users: Array; + teams: Array; +}; + type PullsCreateReviewRequestEndpoint = { /** * owner parameter @@ -10382,12 +32602,482 @@ type PullsCreateReviewRequestEndpoint = { */ team_reviewers?: string[]; }; + type PullsCreateReviewRequestRequestOptions = { method: "POST"; - url: Url; + url: "/repos/:owner/:repo/pulls/:pull_number/requested_reviewers"; headers: RequestHeaders; request: RequestRequestOptions; }; +type PullsCreateReviewRequestResponseDataLinksStatuses = { href: string }; +type PullsCreateReviewRequestResponseDataLinksCommits = { href: string }; +type PullsCreateReviewRequestResponseDataLinksReviewComment = { href: string }; +type PullsCreateReviewRequestResponseDataLinksReviewComments = { href: string }; +type PullsCreateReviewRequestResponseDataLinksComments = { href: string }; +type PullsCreateReviewRequestResponseDataLinksIssue = { href: string }; +type PullsCreateReviewRequestResponseDataLinksHtml = { href: string }; +type PullsCreateReviewRequestResponseDataLinksSelf = { href: string }; +type PullsCreateReviewRequestResponseDataLinks = { + self: PullsCreateReviewRequestResponseDataLinksSelf; + html: PullsCreateReviewRequestResponseDataLinksHtml; + issue: PullsCreateReviewRequestResponseDataLinksIssue; + comments: PullsCreateReviewRequestResponseDataLinksComments; + review_comments: PullsCreateReviewRequestResponseDataLinksReviewComments; + review_comment: PullsCreateReviewRequestResponseDataLinksReviewComment; + commits: PullsCreateReviewRequestResponseDataLinksCommits; + statuses: PullsCreateReviewRequestResponseDataLinksStatuses; +}; +type PullsCreateReviewRequestResponseDataBaseRepoPermissions = { + admin: boolean; + push: boolean; + pull: boolean; +}; +type PullsCreateReviewRequestResponseDataBaseRepoOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type PullsCreateReviewRequestResponseDataBaseRepo = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: PullsCreateReviewRequestResponseDataBaseRepoOwner; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: null; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: Array; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: PullsCreateReviewRequestResponseDataBaseRepoPermissions; + allow_rebase_merge: boolean; + template_repository: null; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; +}; +type PullsCreateReviewRequestResponseDataBaseUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type PullsCreateReviewRequestResponseDataBase = { + label: string; + ref: string; + sha: string; + user: PullsCreateReviewRequestResponseDataBaseUser; + repo: PullsCreateReviewRequestResponseDataBaseRepo; +}; +type PullsCreateReviewRequestResponseDataHeadRepoPermissions = { + admin: boolean; + push: boolean; + pull: boolean; +}; +type PullsCreateReviewRequestResponseDataHeadRepoOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type PullsCreateReviewRequestResponseDataHeadRepo = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: PullsCreateReviewRequestResponseDataHeadRepoOwner; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: null; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: Array; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: PullsCreateReviewRequestResponseDataHeadRepoPermissions; + allow_rebase_merge: boolean; + template_repository: null; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; +}; +type PullsCreateReviewRequestResponseDataHeadUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type PullsCreateReviewRequestResponseDataHead = { + label: string; + ref: string; + sha: string; + user: PullsCreateReviewRequestResponseDataHeadUser; + repo: PullsCreateReviewRequestResponseDataHeadRepo; +}; +type PullsCreateReviewRequestResponseDataRequestedTeamsItem = { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: null; +}; +type PullsCreateReviewRequestResponseDataRequestedReviewersItem = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type PullsCreateReviewRequestResponseDataAssigneesItem = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type PullsCreateReviewRequestResponseDataAssignee = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type PullsCreateReviewRequestResponseDataMilestoneCreator = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type PullsCreateReviewRequestResponseDataMilestone = { + url: string; + html_url: string; + labels_url: string; + id: number; + node_id: string; + number: number; + state: string; + title: string; + description: string; + creator: PullsCreateReviewRequestResponseDataMilestoneCreator; + open_issues: number; + closed_issues: number; + created_at: string; + updated_at: string; + closed_at: string; + due_on: string; +}; +type PullsCreateReviewRequestResponseDataLabelsItem = { + id: number; + node_id: string; + url: string; + name: string; + description: string; + color: string; + default: boolean; +}; +type PullsCreateReviewRequestResponseDataUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type PullsCreateReviewRequestResponseData = { + url: string; + id: number; + node_id: string; + html_url: string; + diff_url: string; + patch_url: string; + issue_url: string; + commits_url: string; + review_comments_url: string; + review_comment_url: string; + comments_url: string; + statuses_url: string; + number: number; + state: string; + locked: boolean; + title: string; + user: PullsCreateReviewRequestResponseDataUser; + body: string; + labels: Array; + milestone: PullsCreateReviewRequestResponseDataMilestone; + active_lock_reason: string; + created_at: string; + updated_at: string; + closed_at: string; + merged_at: string; + merge_commit_sha: string; + assignee: PullsCreateReviewRequestResponseDataAssignee; + assignees: Array; + requested_reviewers: Array< + PullsCreateReviewRequestResponseDataRequestedReviewersItem + >; + requested_teams: Array< + PullsCreateReviewRequestResponseDataRequestedTeamsItem + >; + head: PullsCreateReviewRequestResponseDataHead; + base: PullsCreateReviewRequestResponseDataBase; + _links: PullsCreateReviewRequestResponseDataLinks; + author_association: string; + draft: boolean; +}; + type PullsDeleteReviewRequestEndpoint = { /** * owner parameter @@ -10410,12 +33100,14 @@ type PullsDeleteReviewRequestEndpoint = { */ team_reviewers?: string[]; }; + type PullsDeleteReviewRequestRequestOptions = { method: "DELETE"; - url: Url; + url: "/repos/:owner/:repo/pulls/:pull_number/requested_reviewers"; headers: RequestHeaders; request: RequestRequestOptions; }; + type PullsListReviewsEndpoint = { /** * owner parameter @@ -10438,12 +33130,53 @@ type PullsListReviewsEndpoint = { */ page?: number; }; + type PullsListReviewsRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/pulls/:pull_number/reviews"; headers: RequestHeaders; request: RequestRequestOptions; }; +type PullsListReviewsResponseDataItemLinksPullRequest = { href: string }; +type PullsListReviewsResponseDataItemLinksHtml = { href: string }; +type PullsListReviewsResponseDataItemLinks = { + html: PullsListReviewsResponseDataItemLinksHtml; + pull_request: PullsListReviewsResponseDataItemLinksPullRequest; +}; +type PullsListReviewsResponseDataItemUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type PullsListReviewsResponseDataItem = { + id: number; + node_id: string; + user: PullsListReviewsResponseDataItemUser; + body: string; + submitted_at: string; + commit_id: string; + state: string; + html_url: string; + pull_request_url: string; + _links: PullsListReviewsResponseDataItemLinks; +}; +type PullsListReviewsResponseData = Array; + type PullsCreateReviewEndpoint = { /** * owner parameter @@ -10474,12 +33207,51 @@ type PullsCreateReviewEndpoint = { */ comments?: PullsCreateReviewParamsComments[]; }; + type PullsCreateReviewRequestOptions = { method: "POST"; - url: Url; + url: "/repos/:owner/:repo/pulls/:pull_number/reviews"; headers: RequestHeaders; request: RequestRequestOptions; }; +type PullsCreateReviewResponseDataLinksPullRequest = { href: string }; +type PullsCreateReviewResponseDataLinksHtml = { href: string }; +type PullsCreateReviewResponseDataLinks = { + html: PullsCreateReviewResponseDataLinksHtml; + pull_request: PullsCreateReviewResponseDataLinksPullRequest; +}; +type PullsCreateReviewResponseDataUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type PullsCreateReviewResponseData = { + id: number; + node_id: string; + user: PullsCreateReviewResponseDataUser; + body: string; + commit_id: string; + state: string; + html_url: string; + pull_request_url: string; + _links: PullsCreateReviewResponseDataLinks; +}; + type PullsGetReviewEndpoint = { /** * owner parameter @@ -10498,12 +33270,52 @@ type PullsGetReviewEndpoint = { */ review_id: number; }; + type PullsGetReviewRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id"; headers: RequestHeaders; request: RequestRequestOptions; }; +type PullsGetReviewResponseDataLinksPullRequest = { href: string }; +type PullsGetReviewResponseDataLinksHtml = { href: string }; +type PullsGetReviewResponseDataLinks = { + html: PullsGetReviewResponseDataLinksHtml; + pull_request: PullsGetReviewResponseDataLinksPullRequest; +}; +type PullsGetReviewResponseDataUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type PullsGetReviewResponseData = { + id: number; + node_id: string; + user: PullsGetReviewResponseDataUser; + body: string; + submitted_at: string; + commit_id: string; + state: string; + html_url: string; + pull_request_url: string; + _links: PullsGetReviewResponseDataLinks; +}; + type PullsDeletePendingReviewEndpoint = { /** * owner parameter @@ -10522,12 +33334,51 @@ type PullsDeletePendingReviewEndpoint = { */ review_id: number; }; + type PullsDeletePendingReviewRequestOptions = { method: "DELETE"; - url: Url; + url: "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id"; headers: RequestHeaders; request: RequestRequestOptions; }; +type PullsDeletePendingReviewResponseDataLinksPullRequest = { href: string }; +type PullsDeletePendingReviewResponseDataLinksHtml = { href: string }; +type PullsDeletePendingReviewResponseDataLinks = { + html: PullsDeletePendingReviewResponseDataLinksHtml; + pull_request: PullsDeletePendingReviewResponseDataLinksPullRequest; +}; +type PullsDeletePendingReviewResponseDataUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type PullsDeletePendingReviewResponseData = { + id: number; + node_id: string; + user: PullsDeletePendingReviewResponseDataUser; + body: string; + commit_id: string; + state: string; + html_url: string; + pull_request_url: string; + _links: PullsDeletePendingReviewResponseDataLinks; +}; + type PullsUpdateReviewEndpoint = { /** * owner parameter @@ -10550,12 +33401,51 @@ type PullsUpdateReviewEndpoint = { */ body: string; }; + type PullsUpdateReviewRequestOptions = { method: "PUT"; - url: Url; + url: "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id"; headers: RequestHeaders; request: RequestRequestOptions; }; +type PullsUpdateReviewResponseDataLinksPullRequest = { href: string }; +type PullsUpdateReviewResponseDataLinksHtml = { href: string }; +type PullsUpdateReviewResponseDataLinks = { + html: PullsUpdateReviewResponseDataLinksHtml; + pull_request: PullsUpdateReviewResponseDataLinksPullRequest; +}; +type PullsUpdateReviewResponseDataUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type PullsUpdateReviewResponseData = { + id: number; + node_id: string; + user: PullsUpdateReviewResponseDataUser; + body: string; + commit_id: string; + state: string; + html_url: string; + pull_request_url: string; + _links: PullsUpdateReviewResponseDataLinks; +}; + type PullsGetCommentsForReviewEndpoint = { /** * owner parameter @@ -10582,12 +33472,68 @@ type PullsGetCommentsForReviewEndpoint = { */ page?: number; }; + type PullsGetCommentsForReviewRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/comments"; headers: RequestHeaders; request: RequestRequestOptions; }; +type PullsGetCommentsForReviewResponseDataItemLinksPullRequest = { + href: string; +}; +type PullsGetCommentsForReviewResponseDataItemLinksHtml = { href: string }; +type PullsGetCommentsForReviewResponseDataItemLinksSelf = { href: string }; +type PullsGetCommentsForReviewResponseDataItemLinks = { + self: PullsGetCommentsForReviewResponseDataItemLinksSelf; + html: PullsGetCommentsForReviewResponseDataItemLinksHtml; + pull_request: PullsGetCommentsForReviewResponseDataItemLinksPullRequest; +}; +type PullsGetCommentsForReviewResponseDataItemUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type PullsGetCommentsForReviewResponseDataItem = { + url: string; + id: number; + node_id: string; + pull_request_review_id: number; + diff_hunk: string; + path: string; + position: number; + original_position: number; + commit_id: string; + original_commit_id: string; + in_reply_to_id: number; + user: PullsGetCommentsForReviewResponseDataItemUser; + body: string; + created_at: string; + updated_at: string; + html_url: string; + pull_request_url: string; + author_association: string; + _links: PullsGetCommentsForReviewResponseDataItemLinks; +}; +type PullsGetCommentsForReviewResponseData = Array< + PullsGetCommentsForReviewResponseDataItem +>; + type PullsDismissReviewEndpoint = { /** * owner parameter @@ -10610,12 +33556,51 @@ type PullsDismissReviewEndpoint = { */ message: string; }; + type PullsDismissReviewRequestOptions = { method: "PUT"; - url: Url; + url: "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/dismissals"; headers: RequestHeaders; request: RequestRequestOptions; }; +type PullsDismissReviewResponseDataLinksPullRequest = { href: string }; +type PullsDismissReviewResponseDataLinksHtml = { href: string }; +type PullsDismissReviewResponseDataLinks = { + html: PullsDismissReviewResponseDataLinksHtml; + pull_request: PullsDismissReviewResponseDataLinksPullRequest; +}; +type PullsDismissReviewResponseDataUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type PullsDismissReviewResponseData = { + id: number; + node_id: string; + user: PullsDismissReviewResponseDataUser; + body: string; + commit_id: string; + state: string; + html_url: string; + pull_request_url: string; + _links: PullsDismissReviewResponseDataLinks; +}; + type PullsSubmitReviewEndpoint = { /** * owner parameter @@ -10642,12 +33627,52 @@ type PullsSubmitReviewEndpoint = { */ event: "APPROVE" | "REQUEST_CHANGES" | "COMMENT"; }; + type PullsSubmitReviewRequestOptions = { method: "POST"; - url: Url; + url: "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/events"; headers: RequestHeaders; request: RequestRequestOptions; }; +type PullsSubmitReviewResponseDataLinksPullRequest = { href: string }; +type PullsSubmitReviewResponseDataLinksHtml = { href: string }; +type PullsSubmitReviewResponseDataLinks = { + html: PullsSubmitReviewResponseDataLinksHtml; + pull_request: PullsSubmitReviewResponseDataLinksPullRequest; +}; +type PullsSubmitReviewResponseDataUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type PullsSubmitReviewResponseData = { + id: number; + node_id: string; + user: PullsSubmitReviewResponseDataUser; + body: string; + submitted_at: string; + commit_id: string; + state: string; + html_url: string; + pull_request_url: string; + _links: PullsSubmitReviewResponseDataLinks; +}; + type PullsUpdateBranchEndpoint = { /** * owner parameter @@ -10665,13 +33690,16 @@ type PullsUpdateBranchEndpoint = { * The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a `422 Unprocessable Entity` status. You can use the "[List commits on a repository](https://developer.github.com/v3/repos/commits/#list-commits-on-a-repository)" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref. */ expected_head_sha?: string; -}; +} & RequiredPreview<"lydian">; + type PullsUpdateBranchRequestOptions = { method: "PUT"; - url: Url; + url: "/repos/:owner/:repo/pulls/:pull_number/update-branch"; headers: RequestHeaders; request: RequestRequestOptions; }; +type PullsUpdateBranchResponseData = { message: string; url: string }; + type ReposGetReadmeEndpoint = { /** * owner parameter @@ -10686,12 +33714,33 @@ type ReposGetReadmeEndpoint = { */ ref?: string; }; + type ReposGetReadmeRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/readme"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposGetReadmeResponseDataLinks = { + git: string; + self: string; + html: string; +}; +type ReposGetReadmeResponseData = { + type: string; + encoding: string; + size: number; + name: string; + path: string; + content: string; + sha: string; + url: string; + git_url: string; + html_url: string; + download_url: string; + _links: ReposGetReadmeResponseDataLinks; +}; + type ReposListReleasesEndpoint = { /** * owner parameter @@ -10710,12 +33759,90 @@ type ReposListReleasesEndpoint = { */ page?: number; }; + type ReposListReleasesRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/releases"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposListReleasesResponseDataItemAssetsItemUploader = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposListReleasesResponseDataItemAssetsItem = { + url: string; + browser_download_url: string; + id: number; + node_id: string; + name: string; + label: string; + state: string; + content_type: string; + size: number; + download_count: number; + created_at: string; + updated_at: string; + uploader: ReposListReleasesResponseDataItemAssetsItemUploader; +}; +type ReposListReleasesResponseDataItemAuthor = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposListReleasesResponseDataItem = { + url: string; + html_url: string; + assets_url: string; + upload_url: string; + tarball_url: string; + zipball_url: string; + id: number; + node_id: string; + tag_name: string; + target_commitish: string; + name: string; + body: string; + draft: boolean; + prerelease: boolean; + created_at: string; + published_at: string; + author: ReposListReleasesResponseDataItemAuthor; + assets: Array; +}; +type ReposListReleasesResponseData = Array; + type ReposCreateReleaseEndpoint = { /** * owner parameter @@ -10750,12 +33877,54 @@ type ReposCreateReleaseEndpoint = { */ prerelease?: boolean; }; + type ReposCreateReleaseRequestOptions = { method: "POST"; - url: Url; + url: "/repos/:owner/:repo/releases"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposCreateReleaseResponseDataAuthor = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposCreateReleaseResponseData = { + url: string; + html_url: string; + assets_url: string; + upload_url: string; + tarball_url: string; + zipball_url: string; + id: number; + node_id: string; + tag_name: string; + target_commitish: string; + name: string; + body: string; + draft: boolean; + prerelease: boolean; + created_at: string; + published_at: string; + author: ReposCreateReleaseResponseDataAuthor; + assets: Array; +}; + type ReposGetReleaseAssetEndpoint = { /** * owner parameter @@ -10770,12 +33939,49 @@ type ReposGetReleaseAssetEndpoint = { */ asset_id: number; }; + type ReposGetReleaseAssetRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/releases/assets/:asset_id"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposGetReleaseAssetResponseDataUploader = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposGetReleaseAssetResponseData = { + url: string; + browser_download_url: string; + id: number; + node_id: string; + name: string; + label: string; + state: string; + content_type: string; + size: number; + download_count: number; + created_at: string; + updated_at: string; + uploader: ReposGetReleaseAssetResponseDataUploader; +}; + type ReposUpdateReleaseAssetEndpoint = { /** * owner parameter @@ -10798,12 +34004,49 @@ type ReposUpdateReleaseAssetEndpoint = { */ label?: string; }; + type ReposUpdateReleaseAssetRequestOptions = { method: "PATCH"; - url: Url; + url: "/repos/:owner/:repo/releases/assets/:asset_id"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposUpdateReleaseAssetResponseDataUploader = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposUpdateReleaseAssetResponseData = { + url: string; + browser_download_url: string; + id: number; + node_id: string; + name: string; + label: string; + state: string; + content_type: string; + size: number; + download_count: number; + created_at: string; + updated_at: string; + uploader: ReposUpdateReleaseAssetResponseDataUploader; +}; + type ReposDeleteReleaseAssetEndpoint = { /** * owner parameter @@ -10818,12 +34061,14 @@ type ReposDeleteReleaseAssetEndpoint = { */ asset_id: number; }; + type ReposDeleteReleaseAssetRequestOptions = { method: "DELETE"; - url: Url; + url: "/repos/:owner/:repo/releases/assets/:asset_id"; headers: RequestHeaders; request: RequestRequestOptions; }; + type ReposGetLatestReleaseEndpoint = { /** * owner parameter @@ -10834,12 +34079,89 @@ type ReposGetLatestReleaseEndpoint = { */ repo: string; }; + type ReposGetLatestReleaseRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/releases/latest"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposGetLatestReleaseResponseDataAssetsItemUploader = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposGetLatestReleaseResponseDataAssetsItem = { + url: string; + browser_download_url: string; + id: number; + node_id: string; + name: string; + label: string; + state: string; + content_type: string; + size: number; + download_count: number; + created_at: string; + updated_at: string; + uploader: ReposGetLatestReleaseResponseDataAssetsItemUploader; +}; +type ReposGetLatestReleaseResponseDataAuthor = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposGetLatestReleaseResponseData = { + url: string; + html_url: string; + assets_url: string; + upload_url: string; + tarball_url: string; + zipball_url: string; + id: number; + node_id: string; + tag_name: string; + target_commitish: string; + name: string; + body: string; + draft: boolean; + prerelease: boolean; + created_at: string; + published_at: string; + author: ReposGetLatestReleaseResponseDataAuthor; + assets: Array; +}; + type ReposGetReleaseByTagEndpoint = { /** * owner parameter @@ -10854,12 +34176,89 @@ type ReposGetReleaseByTagEndpoint = { */ tag: string; }; + type ReposGetReleaseByTagRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/releases/tags/:tag"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposGetReleaseByTagResponseDataAssetsItemUploader = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposGetReleaseByTagResponseDataAssetsItem = { + url: string; + browser_download_url: string; + id: number; + node_id: string; + name: string; + label: string; + state: string; + content_type: string; + size: number; + download_count: number; + created_at: string; + updated_at: string; + uploader: ReposGetReleaseByTagResponseDataAssetsItemUploader; +}; +type ReposGetReleaseByTagResponseDataAuthor = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposGetReleaseByTagResponseData = { + url: string; + html_url: string; + assets_url: string; + upload_url: string; + tarball_url: string; + zipball_url: string; + id: number; + node_id: string; + tag_name: string; + target_commitish: string; + name: string; + body: string; + draft: boolean; + prerelease: boolean; + created_at: string; + published_at: string; + author: ReposGetReleaseByTagResponseDataAuthor; + assets: Array; +}; + type ReposGetReleaseEndpoint = { /** * owner parameter @@ -10874,12 +34273,89 @@ type ReposGetReleaseEndpoint = { */ release_id: number; }; + type ReposGetReleaseRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/releases/:release_id"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposGetReleaseResponseDataAssetsItemUploader = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposGetReleaseResponseDataAssetsItem = { + url: string; + browser_download_url: string; + id: number; + node_id: string; + name: string; + label: string; + state: string; + content_type: string; + size: number; + download_count: number; + created_at: string; + updated_at: string; + uploader: ReposGetReleaseResponseDataAssetsItemUploader; +}; +type ReposGetReleaseResponseDataAuthor = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposGetReleaseResponseData = { + url: string; + html_url: string; + assets_url: string; + upload_url: string; + tarball_url: string; + zipball_url: string; + id: number; + node_id: string; + tag_name: string; + target_commitish: string; + name: string; + body: string; + draft: boolean; + prerelease: boolean; + created_at: string; + published_at: string; + author: ReposGetReleaseResponseDataAuthor; + assets: Array; +}; + type ReposUpdateReleaseEndpoint = { /** * owner parameter @@ -10918,12 +34394,89 @@ type ReposUpdateReleaseEndpoint = { */ prerelease?: boolean; }; + type ReposUpdateReleaseRequestOptions = { method: "PATCH"; - url: Url; + url: "/repos/:owner/:repo/releases/:release_id"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposUpdateReleaseResponseDataAssetsItemUploader = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposUpdateReleaseResponseDataAssetsItem = { + url: string; + browser_download_url: string; + id: number; + node_id: string; + name: string; + label: string; + state: string; + content_type: string; + size: number; + download_count: number; + created_at: string; + updated_at: string; + uploader: ReposUpdateReleaseResponseDataAssetsItemUploader; +}; +type ReposUpdateReleaseResponseDataAuthor = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposUpdateReleaseResponseData = { + url: string; + html_url: string; + assets_url: string; + upload_url: string; + tarball_url: string; + zipball_url: string; + id: number; + node_id: string; + tag_name: string; + target_commitish: string; + name: string; + body: string; + draft: boolean; + prerelease: boolean; + created_at: string; + published_at: string; + author: ReposUpdateReleaseResponseDataAuthor; + assets: Array; +}; + type ReposDeleteReleaseEndpoint = { /** * owner parameter @@ -10938,12 +34491,14 @@ type ReposDeleteReleaseEndpoint = { */ release_id: number; }; + type ReposDeleteReleaseRequestOptions = { method: "DELETE"; - url: Url; + url: "/repos/:owner/:repo/releases/:release_id"; headers: RequestHeaders; request: RequestRequestOptions; }; + type ReposListAssetsForReleaseEndpoint = { /** * owner parameter @@ -10966,12 +34521,128 @@ type ReposListAssetsForReleaseEndpoint = { */ page?: number; }; + type ReposListAssetsForReleaseRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/releases/:release_id/assets"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposListAssetsForReleaseResponseDataItemUploader = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposListAssetsForReleaseResponseDataItem = { + url: string; + browser_download_url: string; + id: number; + node_id: string; + name: string; + label: string; + state: string; + content_type: string; + size: number; + download_count: number; + created_at: string; + updated_at: string; + uploader: ReposListAssetsForReleaseResponseDataItemUploader; +}; +type ReposListAssetsForReleaseResponseData = Array< + ReposListAssetsForReleaseResponseDataItem +>; + +type ReposUploadReleaseAssetEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * release_id parameter + */ + release_id: number; + /** + * name parameter + */ + name?: string; + /** + * label parameter + */ + label?: string; + /** + * The raw file data + */ + data: string; + /** + * The URL origin (protocol + host name + port) is included in `upload_url` returned in the response of the "Create a release" endpoint + */ + origin?: string; + /** + * For https://api.github.com, set `baseUrl` to `https://uploads.github.com`. For GitHub Enterprise Server, set it to `/api/uploads` + */ + baseUrl: string; +} & { headers: { "content-type": string } }; +type ReposUploadReleaseAssetRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/releases/:release_id/assets{?name,label}"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposUploadReleaseAssetResponseDataUploader = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposUploadReleaseAssetResponseData = { + url: string; + browser_download_url: string; + id: number; + node_id: string; + name: string; + label: string; + state: string; + content_type: string; + size: number; + download_count: number; + created_at: string; + updated_at: string; + uploader: ReposUploadReleaseAssetResponseDataUploader; +}; + type ActivityListStargazersForRepoEndpoint = { /** * owner parameter @@ -10990,12 +34661,37 @@ type ActivityListStargazersForRepoEndpoint = { */ page?: number; }; + type ActivityListStargazersForRepoRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/stargazers"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ActivityListStargazersForRepoResponseDataItem = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ActivityListStargazersForRepoResponseData = Array< + ActivityListStargazersForRepoResponseDataItem +>; + type ReposGetCodeFrequencyStatsEndpoint = { /** * owner parameter @@ -11006,12 +34702,15 @@ type ReposGetCodeFrequencyStatsEndpoint = { */ repo: string; }; + type ReposGetCodeFrequencyStatsRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/stats/code_frequency"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposGetCodeFrequencyStatsResponseData = Array>; + type ReposGetCommitActivityStatsEndpoint = { /** * owner parameter @@ -11022,12 +34721,22 @@ type ReposGetCommitActivityStatsEndpoint = { */ repo: string; }; + type ReposGetCommitActivityStatsRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/stats/commit_activity"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposGetCommitActivityStatsResponseDataItem = { + days: Array; + total: number; + week: number; +}; +type ReposGetCommitActivityStatsResponseData = Array< + ReposGetCommitActivityStatsResponseDataItem +>; + type ReposGetContributorsStatsEndpoint = { /** * owner parameter @@ -11038,12 +34747,48 @@ type ReposGetContributorsStatsEndpoint = { */ repo: string; }; + type ReposGetContributorsStatsRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/stats/contributors"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposGetContributorsStatsResponseDataItemWeeksItem = { + w: string; + a: number; + d: number; + c: number; +}; +type ReposGetContributorsStatsResponseDataItemAuthor = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposGetContributorsStatsResponseDataItem = { + author: ReposGetContributorsStatsResponseDataItemAuthor; + total: number; + weeks: Array; +}; +type ReposGetContributorsStatsResponseData = Array< + ReposGetContributorsStatsResponseDataItem +>; + type ReposGetParticipationStatsEndpoint = { /** * owner parameter @@ -11054,12 +34799,18 @@ type ReposGetParticipationStatsEndpoint = { */ repo: string; }; + type ReposGetParticipationStatsRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/stats/participation"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposGetParticipationStatsResponseData = { + all: Array; + owner: Array; +}; + type ReposGetPunchCardStatsEndpoint = { /** * owner parameter @@ -11070,12 +34821,15 @@ type ReposGetPunchCardStatsEndpoint = { */ repo: string; }; + type ReposGetPunchCardStatsRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/stats/punch_card"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposGetPunchCardStatsResponseData = Array>; + type ReposCreateStatusEndpoint = { /** * owner parameter @@ -11108,12 +34862,47 @@ type ReposCreateStatusEndpoint = { */ context?: string; }; + type ReposCreateStatusRequestOptions = { method: "POST"; - url: Url; + url: "/repos/:owner/:repo/statuses/:sha"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposCreateStatusResponseDataCreator = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposCreateStatusResponseData = { + url: string; + avatar_url: string; + id: number; + node_id: string; + state: string; + description: string; + target_url: string; + context: string; + created_at: string; + updated_at: string; + creator: ReposCreateStatusResponseDataCreator; +}; + type ActivityListWatchersForRepoEndpoint = { /** * owner parameter @@ -11132,12 +34921,37 @@ type ActivityListWatchersForRepoEndpoint = { */ page?: number; }; + type ActivityListWatchersForRepoRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/subscribers"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ActivityListWatchersForRepoResponseDataItem = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ActivityListWatchersForRepoResponseData = Array< + ActivityListWatchersForRepoResponseDataItem +>; + type ActivityGetRepoSubscriptionEndpoint = { /** * owner parameter @@ -11148,12 +34962,22 @@ type ActivityGetRepoSubscriptionEndpoint = { */ repo: string; }; + type ActivityGetRepoSubscriptionRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/subscription"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ActivityGetRepoSubscriptionResponseData = { + subscribed: boolean; + ignored: boolean; + reason: null; + created_at: string; + url: string; + repository_url: string; +}; + type ActivitySetRepoSubscriptionEndpoint = { /** * owner parameter @@ -11172,12 +34996,22 @@ type ActivitySetRepoSubscriptionEndpoint = { */ ignored?: boolean; }; + type ActivitySetRepoSubscriptionRequestOptions = { method: "PUT"; - url: Url; + url: "/repos/:owner/:repo/subscription"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ActivitySetRepoSubscriptionResponseData = { + subscribed: boolean; + ignored: boolean; + reason: null; + created_at: string; + url: string; + repository_url: string; +}; + type ActivityDeleteRepoSubscriptionEndpoint = { /** * owner parameter @@ -11188,12 +35022,14 @@ type ActivityDeleteRepoSubscriptionEndpoint = { */ repo: string; }; + type ActivityDeleteRepoSubscriptionRequestOptions = { method: "DELETE"; - url: Url; + url: "/repos/:owner/:repo/subscription"; headers: RequestHeaders; request: RequestRequestOptions; }; + type ReposListTagsEndpoint = { /** * owner parameter @@ -11212,12 +35048,22 @@ type ReposListTagsEndpoint = { */ page?: number; }; + type ReposListTagsRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/tags"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposListTagsResponseDataItemCommit = { sha: string; url: string }; +type ReposListTagsResponseDataItem = { + name: string; + commit: ReposListTagsResponseDataItemCommit; + zipball_url: string; + tarball_url: string; +}; +type ReposListTagsResponseData = Array; + type ReposListTeamsEndpoint = { /** * owner parameter @@ -11236,13 +35082,30 @@ type ReposListTeamsEndpoint = { */ page?: number; }; + type ReposListTeamsRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/teams"; headers: RequestHeaders; request: RequestRequestOptions; }; -type ReposListTopicsEndpoint = { +type ReposListTeamsResponseDataItem = { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: null; +}; +type ReposListTeamsResponseData = Array; + +type ReposGetAllTopicsEndpoint = { /** * owner parameter */ @@ -11251,14 +35114,17 @@ type ReposListTopicsEndpoint = { * repo parameter */ repo: string; -}; -type ReposListTopicsRequestOptions = { +} & RequiredPreview<"mercy">; + +type ReposGetAllTopicsRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/topics"; headers: RequestHeaders; request: RequestRequestOptions; }; -type ReposReplaceTopicsEndpoint = { +type ReposGetAllTopicsResponseData = { names: Array }; + +type ReposReplaceAllTopicsEndpoint = { /** * owner parameter */ @@ -11271,13 +35137,16 @@ type ReposReplaceTopicsEndpoint = { * An array of topics to add to the repository. Pass one or more topics to _replace_ the set of existing topics. Send an empty array (`[]`) to clear all topics from the repository. **Note:** Topic `names` cannot contain uppercase letters. */ names: string[]; -}; -type ReposReplaceTopicsRequestOptions = { +} & RequiredPreview<"mercy">; + +type ReposReplaceAllTopicsRequestOptions = { method: "PUT"; - url: Url; + url: "/repos/:owner/:repo/topics"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposReplaceAllTopicsResponseData = { names: Array }; + type ReposGetClonesEndpoint = { /** * owner parameter @@ -11292,12 +35161,24 @@ type ReposGetClonesEndpoint = { */ per?: "day" | "week"; }; + type ReposGetClonesRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/traffic/clones"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposGetClonesResponseDataClonesItem = { + timestamp: string; + count: number; + uniques: number; +}; +type ReposGetClonesResponseData = { + count: number; + uniques: number; + clones: Array; +}; + type ReposGetTopPathsEndpoint = { /** * owner parameter @@ -11308,12 +35189,21 @@ type ReposGetTopPathsEndpoint = { */ repo: string; }; + type ReposGetTopPathsRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/traffic/popular/paths"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposGetTopPathsResponseDataItem = { + path: string; + title: string; + count: number; + uniques: number; +}; +type ReposGetTopPathsResponseData = Array; + type ReposGetTopReferrersEndpoint = { /** * owner parameter @@ -11324,12 +35214,22 @@ type ReposGetTopReferrersEndpoint = { */ repo: string; }; + type ReposGetTopReferrersRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/traffic/popular/referrers"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposGetTopReferrersResponseDataItem = { + referrer: string; + count: number; + uniques: number; +}; +type ReposGetTopReferrersResponseData = Array< + ReposGetTopReferrersResponseDataItem +>; + type ReposGetViewsEndpoint = { /** * owner parameter @@ -11344,12 +35244,24 @@ type ReposGetViewsEndpoint = { */ per?: "day" | "week"; }; + type ReposGetViewsRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/traffic/views"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposGetViewsResponseDataViewsItem = { + timestamp: string; + count: number; + uniques: number; +}; +type ReposGetViewsResponseData = { + count: number; + uniques: number; + views: Array; +}; + type ReposTransferEndpoint = { /** * owner parameter @@ -11368,12 +35280,121 @@ type ReposTransferEndpoint = { */ team_ids?: number[]; }; + type ReposTransferRequestOptions = { method: "POST"; - url: Url; + url: "/repos/:owner/:repo/transfer"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposTransferResponseDataPermissions = { + admin: boolean; + push: boolean; + pull: boolean; +}; +type ReposTransferResponseDataOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposTransferResponseData = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: ReposTransferResponseDataOwner; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: null; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: Array; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: ReposTransferResponseDataPermissions; + allow_rebase_merge: boolean; + template_repository: null; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; +}; + type ReposCheckVulnerabilityAlertsEndpoint = { /** * owner parameter @@ -11383,13 +35404,15 @@ type ReposCheckVulnerabilityAlertsEndpoint = { * repo parameter */ repo: string; -}; +} & RequiredPreview<"dorian">; + type ReposCheckVulnerabilityAlertsRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/vulnerability-alerts"; headers: RequestHeaders; request: RequestRequestOptions; }; + type ReposEnableVulnerabilityAlertsEndpoint = { /** * owner parameter @@ -11399,13 +35422,15 @@ type ReposEnableVulnerabilityAlertsEndpoint = { * repo parameter */ repo: string; -}; +} & RequiredPreview<"dorian">; + type ReposEnableVulnerabilityAlertsRequestOptions = { method: "PUT"; - url: Url; + url: "/repos/:owner/:repo/vulnerability-alerts"; headers: RequestHeaders; request: RequestRequestOptions; }; + type ReposDisableVulnerabilityAlertsEndpoint = { /** * owner parameter @@ -11415,13 +35440,15 @@ type ReposDisableVulnerabilityAlertsEndpoint = { * repo parameter */ repo: string; -}; +} & RequiredPreview<"dorian">; + type ReposDisableVulnerabilityAlertsRequestOptions = { method: "DELETE"; - url: Url; + url: "/repos/:owner/:repo/vulnerability-alerts"; headers: RequestHeaders; request: RequestRequestOptions; }; + type ReposGetArchiveLinkEndpoint = { /** * owner parameter @@ -11440,12 +35467,14 @@ type ReposGetArchiveLinkEndpoint = { */ ref: string; }; + type ReposGetArchiveLinkRequestOptions = { method: "GET"; - url: Url; + url: "/repos/:owner/:repo/:archive_format/:ref"; headers: RequestHeaders; request: RequestRequestOptions; }; + type ReposCreateUsingTemplateEndpoint = { /** * template_owner parameter @@ -11471,33 +35500,313 @@ type ReposCreateUsingTemplateEndpoint = { * Either `true` to create a new private repository or `false` to create a new public one. */ private?: boolean; -}; +} & RequiredPreview<"baptiste">; + type ReposCreateUsingTemplateRequestOptions = { method: "POST"; - url: Url; + url: "/repos/:template_owner/:template_repo/generate"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposCreateUsingTemplateResponseDataTemplateRepositoryPermissions = { + admin: boolean; + push: boolean; + pull: boolean; +}; +type ReposCreateUsingTemplateResponseDataTemplateRepositoryOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposCreateUsingTemplateResponseDataTemplateRepository = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: ReposCreateUsingTemplateResponseDataTemplateRepositoryOwner; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: null; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: Array; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: ReposCreateUsingTemplateResponseDataTemplateRepositoryPermissions; + allow_rebase_merge: boolean; + template_repository: null; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; +}; +type ReposCreateUsingTemplateResponseDataPermissions = { + admin: boolean; + push: boolean; + pull: boolean; +}; +type ReposCreateUsingTemplateResponseDataOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposCreateUsingTemplateResponseData = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: ReposCreateUsingTemplateResponseDataOwner; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: null; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: Array; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: ReposCreateUsingTemplateResponseDataPermissions; + allow_rebase_merge: boolean; + template_repository: ReposCreateUsingTemplateResponseDataTemplateRepository; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; +}; + type ReposListPublicEndpoint = { /** - * The integer ID of the last Repository that you've seen. + * The integer ID of the last repository that you've seen. */ - since?: string; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; + since?: number; }; + type ReposListPublicRequestOptions = { method: "GET"; - url: Url; + url: "/repositories"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposListPublicResponseDataItemOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposListPublicResponseDataItem = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: ReposListPublicResponseDataItemOwner; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; +}; +type ReposListPublicResponseData = Array; + type ScimListProvisionedIdentitiesEndpoint = { /** * org parameter @@ -11516,36 +35825,87 @@ type ScimListProvisionedIdentitiesEndpoint = { */ filter?: string; }; + type ScimListProvisionedIdentitiesRequestOptions = { method: "GET"; - url: Url; + url: "/scim/v2/organizations/:org/Users"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ScimListProvisionedIdentitiesResponseDataResourcesItemMeta = { + resourceType: string; + created: string; + lastModified: string; + location: string; +}; +type ScimListProvisionedIdentitiesResponseDataResourcesItemEmailsItem = { + value: string; + primary: boolean; + type: string; +}; +type ScimListProvisionedIdentitiesResponseDataResourcesItemName = { + givenName: string; + familyName: string; +}; +type ScimListProvisionedIdentitiesResponseDataResourcesItem = { + schemas: Array; + id: string; + externalId: string; + userName: string; + name: ScimListProvisionedIdentitiesResponseDataResourcesItemName; + emails: Array< + ScimListProvisionedIdentitiesResponseDataResourcesItemEmailsItem + >; + active: boolean; + meta: ScimListProvisionedIdentitiesResponseDataResourcesItemMeta; +}; +type ScimListProvisionedIdentitiesResponseData = { + schemas: Array; + totalResults: number; + itemsPerPage: number; + startIndex: number; + Resources: Array; +}; + type ScimProvisionAndInviteUsersEndpoint = { /** * org parameter */ org: string; }; + type ScimProvisionAndInviteUsersRequestOptions = { method: "POST"; - url: Url; + url: "/scim/v2/organizations/:org/Users"; headers: RequestHeaders; request: RequestRequestOptions; }; -type ScimProvisionInviteUsersEndpoint = { - /** - * org parameter - */ - org: string; +type ScimProvisionAndInviteUsersResponseDataMeta = { + resourceType: string; + created: string; + lastModified: string; + location: string; }; -type ScimProvisionInviteUsersRequestOptions = { - method: "POST"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; +type ScimProvisionAndInviteUsersResponseDataEmailsItem = { + value: string; + type: string; + primary: boolean; }; +type ScimProvisionAndInviteUsersResponseDataName = { + givenName: string; + familyName: string; +}; +type ScimProvisionAndInviteUsersResponseData = { + schemas: Array; + id: string; + externalId: string; + userName: string; + name: ScimProvisionAndInviteUsersResponseDataName; + emails: Array; + active: boolean; + meta: ScimProvisionAndInviteUsersResponseDataMeta; +}; + type ScimGetProvisioningDetailsForUserEndpoint = { /** * org parameter @@ -11556,12 +35916,39 @@ type ScimGetProvisioningDetailsForUserEndpoint = { */ scim_user_id: number; }; + type ScimGetProvisioningDetailsForUserRequestOptions = { method: "GET"; - url: Url; + url: "/scim/v2/organizations/:org/Users/:scim_user_id"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ScimGetProvisioningDetailsForUserResponseDataMeta = { + resourceType: string; + created: string; + lastModified: string; + location: string; +}; +type ScimGetProvisioningDetailsForUserResponseDataEmailsItem = { + value: string; + type: string; + primary: boolean; +}; +type ScimGetProvisioningDetailsForUserResponseDataName = { + givenName: string; + familyName: string; +}; +type ScimGetProvisioningDetailsForUserResponseData = { + schemas: Array; + id: string; + externalId: string; + userName: string; + name: ScimGetProvisioningDetailsForUserResponseDataName; + emails: Array; + active: boolean; + meta: ScimGetProvisioningDetailsForUserResponseDataMeta; +}; + type ScimReplaceProvisionedUserInformationEndpoint = { /** * org parameter @@ -11572,28 +35959,39 @@ type ScimReplaceProvisionedUserInformationEndpoint = { */ scim_user_id: number; }; + type ScimReplaceProvisionedUserInformationRequestOptions = { method: "PUT"; - url: Url; + url: "/scim/v2/organizations/:org/Users/:scim_user_id"; headers: RequestHeaders; request: RequestRequestOptions; }; -type ScimUpdateProvisionedOrgMembershipEndpoint = { - /** - * org parameter - */ - org: string; - /** - * scim_user_id parameter - */ - scim_user_id: number; +type ScimReplaceProvisionedUserInformationResponseDataMeta = { + resourceType: string; + created: string; + lastModified: string; + location: string; }; -type ScimUpdateProvisionedOrgMembershipRequestOptions = { - method: "PUT"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; +type ScimReplaceProvisionedUserInformationResponseDataEmailsItem = { + value: string; + type: string; + primary: boolean; }; +type ScimReplaceProvisionedUserInformationResponseDataName = { + givenName: string; + familyName: string; +}; +type ScimReplaceProvisionedUserInformationResponseData = { + schemas: Array; + id: string; + externalId: string; + userName: string; + name: ScimReplaceProvisionedUserInformationResponseDataName; + emails: Array; + active: boolean; + meta: ScimReplaceProvisionedUserInformationResponseDataMeta; +}; + type ScimUpdateUserAttributeEndpoint = { /** * org parameter @@ -11604,12 +36002,39 @@ type ScimUpdateUserAttributeEndpoint = { */ scim_user_id: number; }; + type ScimUpdateUserAttributeRequestOptions = { method: "PATCH"; - url: Url; + url: "/scim/v2/organizations/:org/Users/:scim_user_id"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ScimUpdateUserAttributeResponseDataMeta = { + resourceType: string; + created: string; + lastModified: string; + location: string; +}; +type ScimUpdateUserAttributeResponseDataEmailsItem = { + value: string; + type: string; + primary?: boolean; +}; +type ScimUpdateUserAttributeResponseDataName = { + givenName: string; + familyName: string; +}; +type ScimUpdateUserAttributeResponseData = { + schemas: Array; + id: string; + externalId: string; + userName: string; + name: ScimUpdateUserAttributeResponseDataName; + emails: Array; + active: boolean; + meta: ScimUpdateUserAttributeResponseDataMeta; +}; + type ScimRemoveUserFromOrgEndpoint = { /** * org parameter @@ -11620,12 +36045,14 @@ type ScimRemoveUserFromOrgEndpoint = { */ scim_user_id: number; }; + type ScimRemoveUserFromOrgRequestOptions = { method: "DELETE"; - url: Url; + url: "/scim/v2/organizations/:org/Users/:scim_user_id"; headers: RequestHeaders; request: RequestRequestOptions; }; + type SearchCodeEndpoint = { /** * The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). See "[Searching code](https://help.github.com/articles/searching-code/)" for a detailed list of qualifiers. @@ -11648,12 +36075,95 @@ type SearchCodeEndpoint = { */ page?: number; }; + type SearchCodeRequestOptions = { method: "GET"; - url: Url; + url: "/search/code"; headers: RequestHeaders; request: RequestRequestOptions; }; +type SearchCodeResponseDataItemsItemRepositoryOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type SearchCodeResponseDataItemsItemRepository = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: SearchCodeResponseDataItemsItemRepositoryOwner; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + forks_url: string; + keys_url: string; + collaborators_url: string; + teams_url: string; + hooks_url: string; + issue_events_url: string; + events_url: string; + assignees_url: string; + branches_url: string; + tags_url: string; + blobs_url: string; + git_tags_url: string; + git_refs_url: string; + trees_url: string; + statuses_url: string; + languages_url: string; + stargazers_url: string; + contributors_url: string; + subscribers_url: string; + subscription_url: string; + commits_url: string; + git_commits_url: string; + comments_url: string; + issue_comment_url: string; + contents_url: string; + compare_url: string; + merges_url: string; + archive_url: string; + downloads_url: string; + issues_url: string; + pulls_url: string; + milestones_url: string; + notifications_url: string; + labels_url: string; +}; +type SearchCodeResponseDataItemsItem = { + name: string; + path: string; + sha: string; + url: string; + git_url: string; + html_url: string; + repository: SearchCodeResponseDataItemsItemRepository; + score: number; +}; +type SearchCodeResponseData = { + total_count: number; + incomplete_results: boolean; + items: Array; +}; + type SearchCommitsEndpoint = { /** * The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). See "[Searching commits](https://help.github.com/articles/searching-commits/)" for a detailed list of qualifiers. @@ -11675,13 +36185,167 @@ type SearchCommitsEndpoint = { * Page number of the results to fetch. */ page?: number; -}; +} & RequiredPreview<"cloak">; + type SearchCommitsRequestOptions = { method: "GET"; - url: Url; + url: "/search/commits"; headers: RequestHeaders; request: RequestRequestOptions; }; +type SearchCommitsResponseDataItemsItemRepositoryOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type SearchCommitsResponseDataItemsItemRepository = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: SearchCommitsResponseDataItemsItemRepositoryOwner; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + forks_url: string; + keys_url: string; + collaborators_url: string; + teams_url: string; + hooks_url: string; + issue_events_url: string; + events_url: string; + assignees_url: string; + branches_url: string; + tags_url: string; + blobs_url: string; + git_tags_url: string; + git_refs_url: string; + trees_url: string; + statuses_url: string; + languages_url: string; + stargazers_url: string; + contributors_url: string; + subscribers_url: string; + subscription_url: string; + commits_url: string; + git_commits_url: string; + comments_url: string; + issue_comment_url: string; + contents_url: string; + compare_url: string; + merges_url: string; + archive_url: string; + downloads_url: string; + issues_url: string; + pulls_url: string; + milestones_url: string; + notifications_url: string; + labels_url: string; + releases_url: string; + deployments_url: string; +}; +type SearchCommitsResponseDataItemsItemParentsItem = { + url: string; + html_url: string; + sha: string; +}; +type SearchCommitsResponseDataItemsItemCommitter = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type SearchCommitsResponseDataItemsItemAuthor = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type SearchCommitsResponseDataItemsItemCommitTree = { + url: string; + sha: string; +}; +type SearchCommitsResponseDataItemsItemCommitCommitter = { + date: string; + name: string; + email: string; +}; +type SearchCommitsResponseDataItemsItemCommitAuthor = { + date: string; + name: string; + email: string; +}; +type SearchCommitsResponseDataItemsItemCommit = { + url: string; + author: SearchCommitsResponseDataItemsItemCommitAuthor; + committer: SearchCommitsResponseDataItemsItemCommitCommitter; + message: string; + tree: SearchCommitsResponseDataItemsItemCommitTree; + comment_count: number; +}; +type SearchCommitsResponseDataItemsItem = { + url: string; + sha: string; + html_url: string; + comments_url: string; + commit: SearchCommitsResponseDataItemsItemCommit; + author: SearchCommitsResponseDataItemsItemAuthor; + committer: SearchCommitsResponseDataItemsItemCommitter; + parents: Array; + repository: SearchCommitsResponseDataItemsItemRepository; + score: number; +}; +type SearchCommitsResponseData = { + total_count: number; + incomplete_results: boolean; + items: Array; +}; + type SearchIssuesAndPullRequestsEndpoint = { /** * The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). See "[Searching issues and pull requests](https://help.github.com/articles/searching-issues-and-pull-requests/)" for a detailed list of qualifiers. @@ -11715,51 +36379,74 @@ type SearchIssuesAndPullRequestsEndpoint = { */ page?: number; }; + type SearchIssuesAndPullRequestsRequestOptions = { method: "GET"; - url: Url; + url: "/search/issues"; headers: RequestHeaders; request: RequestRequestOptions; }; -type SearchIssuesEndpoint = { - /** - * The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). See "[Searching issues and pull requests](https://help.github.com/articles/searching-issues-and-pull-requests/)" for a detailed list of qualifiers. - */ - q: string; - /** - * Sorts the results of your query by the number of `comments`, `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: [best match](https://developer.github.com/v3/search/#ranking-search-results) - */ - sort?: - | "comments" - | "reactions" - | "reactions-+1" - | "reactions--1" - | "reactions-smile" - | "reactions-thinking_face" - | "reactions-heart" - | "reactions-tada" - | "interactions" - | "created" - | "updated"; - /** - * Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. - */ - order?: "desc" | "asc"; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; +type SearchIssuesAndPullRequestsResponseDataItemsItemPullRequest = { + html_url: null; + diff_url: null; + patch_url: null; }; -type SearchIssuesRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; +type SearchIssuesAndPullRequestsResponseDataItemsItemLabelsItem = { + id: number; + node_id: string; + url: string; + name: string; + color: string; }; +type SearchIssuesAndPullRequestsResponseDataItemsItemUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; +}; +type SearchIssuesAndPullRequestsResponseDataItemsItem = { + url: string; + repository_url: string; + labels_url: string; + comments_url: string; + events_url: string; + html_url: string; + id: number; + node_id: string; + number: number; + title: string; + user: SearchIssuesAndPullRequestsResponseDataItemsItemUser; + labels: Array; + state: string; + assignee: null; + milestone: null; + comments: number; + created_at: string; + updated_at: string; + closed_at: null; + pull_request: SearchIssuesAndPullRequestsResponseDataItemsItemPullRequest; + body: string; + score: number; +}; +type SearchIssuesAndPullRequestsResponseData = { + total_count: number; + incomplete_results: boolean; + items: Array; +}; + type SearchLabelsEndpoint = { /** * The id of the repository. @@ -11778,12 +36465,29 @@ type SearchLabelsEndpoint = { */ order?: "desc" | "asc"; }; + type SearchLabelsRequestOptions = { method: "GET"; - url: Url; + url: "/search/labels"; headers: RequestHeaders; request: RequestRequestOptions; }; +type SearchLabelsResponseDataItemsItem = { + id: number; + node_id: string; + url: string; + name: string; + color: string; + default: boolean; + description: string; + score: number; +}; +type SearchLabelsResponseData = { + total_count: number; + incomplete_results: boolean; + items: Array; +}; + type SearchReposEndpoint = { /** * The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). See "[Searching for repositories](https://help.github.com/articles/searching-for-repositories/)" for a detailed list of qualifiers. @@ -11806,24 +36510,86 @@ type SearchReposEndpoint = { */ page?: number; }; + type SearchReposRequestOptions = { method: "GET"; - url: Url; + url: "/search/repositories"; headers: RequestHeaders; request: RequestRequestOptions; }; +type SearchReposResponseDataItemsItemOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + received_events_url: string; + type: string; +}; +type SearchReposResponseDataItemsItem = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: SearchReposResponseDataItemsItemOwner; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + created_at: string; + updated_at: string; + pushed_at: string; + homepage: string; + size: number; + stargazers_count: number; + watchers_count: number; + language: string; + forks_count: number; + open_issues_count: number; + master_branch: string; + default_branch: string; + score: number; +}; +type SearchReposResponseData = { + total_count: number; + incomplete_results: boolean; + items: Array; +}; + type SearchTopicsEndpoint = { /** * The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). */ q: string; }; + type SearchTopicsRequestOptions = { method: "GET"; - url: Url; + url: "/search/topics"; headers: RequestHeaders; request: RequestRequestOptions; }; +type SearchTopicsResponseDataItemsItem = { + name: string; + display_name: string; + short_description: string; + description: string; + created_by: string; + released: string; + created_at: string; + updated_at: string; + featured: boolean; + curated: boolean; + score: number; +}; +type SearchTopicsResponseData = { + total_count: number; + incomplete_results: boolean; + items: Array; +}; + type SearchUsersEndpoint = { /** * The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). See "[Searching users](https://help.github.com/articles/searching-users/)" for a detailed list of qualifiers. @@ -11846,25 +36612,98 @@ type SearchUsersEndpoint = { */ page?: number; }; + type SearchUsersRequestOptions = { method: "GET"; - url: Url; + url: "/search/users"; headers: RequestHeaders; request: RequestRequestOptions; }; -type TeamsGetEndpoint = { +type SearchUsersResponseDataItemsItem = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + received_events_url: string; + type: string; + score: number; +}; +type SearchUsersResponseData = { + total_count: number; + incomplete_results: boolean; + items: Array; +}; + +type TeamsGetLegacyEndpoint = { /** * team_id parameter */ team_id: number; }; -type TeamsGetRequestOptions = { + +type TeamsGetLegacyRequestOptions = { method: "GET"; - url: Url; + url: "/teams/:team_id"; headers: RequestHeaders; request: RequestRequestOptions; }; -type TeamsUpdateEndpoint = { +type TeamsGetLegacyResponseDataOrganization = { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; + name: string; + company: string; + blog: string; + location: string; + email: string; + is_verified: boolean; + has_organization_projects: boolean; + has_repository_projects: boolean; + public_repos: number; + public_gists: number; + followers: number; + following: number; + html_url: string; + created_at: string; + type: string; +}; +type TeamsGetLegacyResponseData = { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: null; + members_count: number; + repos_count: number; + created_at: string; + updated_at: string; + organization: TeamsGetLegacyResponseDataOrganization; +}; + +type TeamsUpdateLegacyEndpoint = { /** * team_id parameter */ @@ -11894,29 +36733,81 @@ type TeamsUpdateEndpoint = { */ permission?: "pull" | "push" | "admin"; /** - * The ID of a team to set as the parent team. **Note**: You must pass the `hellcat-preview` media type to use this parameter. + * The ID of a team to set as the parent team. */ parent_team_id?: number; }; -type TeamsUpdateRequestOptions = { + +type TeamsUpdateLegacyRequestOptions = { method: "PATCH"; - url: Url; + url: "/teams/:team_id"; headers: RequestHeaders; request: RequestRequestOptions; }; -type TeamsDeleteEndpoint = { +type TeamsUpdateLegacyResponseDataOrganization = { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; + name: string; + company: string; + blog: string; + location: string; + email: string; + is_verified: boolean; + has_organization_projects: boolean; + has_repository_projects: boolean; + public_repos: number; + public_gists: number; + followers: number; + following: number; + html_url: string; + created_at: string; + type: string; +}; +type TeamsUpdateLegacyResponseData = { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: null; + members_count: number; + repos_count: number; + created_at: string; + updated_at: string; + organization: TeamsUpdateLegacyResponseDataOrganization; +}; + +type TeamsDeleteLegacyEndpoint = { /** * team_id parameter */ team_id: number; }; -type TeamsDeleteRequestOptions = { + +type TeamsDeleteLegacyRequestOptions = { method: "DELETE"; - url: Url; + url: "/teams/:team_id"; headers: RequestHeaders; request: RequestRequestOptions; }; -type TeamsListDiscussionsEndpoint = { + +type TeamsListDiscussionsLegacyEndpoint = { /** * team_id parameter */ @@ -11934,13 +36825,68 @@ type TeamsListDiscussionsEndpoint = { */ page?: number; }; -type TeamsListDiscussionsRequestOptions = { + +type TeamsListDiscussionsLegacyRequestOptions = { method: "GET"; - url: Url; + url: "/teams/:team_id/discussions"; headers: RequestHeaders; request: RequestRequestOptions; }; -type TeamsCreateDiscussionEndpoint = { +type TeamsListDiscussionsLegacyResponseDataItemReactions = { + url: string; + total_count: number; + "+1": number; + "-1": number; + laugh: number; + confused: number; + heart: number; + hooray: number; +}; +type TeamsListDiscussionsLegacyResponseDataItemAuthor = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type TeamsListDiscussionsLegacyResponseDataItem = { + author: TeamsListDiscussionsLegacyResponseDataItemAuthor; + body: string; + body_html: string; + body_version: string; + comments_count: number; + comments_url: string; + created_at: string; + last_edited_at: null; + html_url: string; + node_id: string; + number: number; + pinned: boolean; + private: boolean; + team_url: string; + title: string; + updated_at: string; + url: string; + reactions: TeamsListDiscussionsLegacyResponseDataItemReactions; +}; +type TeamsListDiscussionsLegacyResponseData = Array< + TeamsListDiscussionsLegacyResponseDataItem +>; + +type TeamsCreateDiscussionLegacyEndpoint = { /** * team_id parameter */ @@ -11958,13 +36904,65 @@ type TeamsCreateDiscussionEndpoint = { */ private?: boolean; }; -type TeamsCreateDiscussionRequestOptions = { + +type TeamsCreateDiscussionLegacyRequestOptions = { method: "POST"; - url: Url; + url: "/teams/:team_id/discussions"; headers: RequestHeaders; request: RequestRequestOptions; }; -type TeamsGetDiscussionEndpoint = { +type TeamsCreateDiscussionLegacyResponseDataReactions = { + url: string; + total_count: number; + "+1": number; + "-1": number; + laugh: number; + confused: number; + heart: number; + hooray: number; +}; +type TeamsCreateDiscussionLegacyResponseDataAuthor = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type TeamsCreateDiscussionLegacyResponseData = { + author: TeamsCreateDiscussionLegacyResponseDataAuthor; + body: string; + body_html: string; + body_version: string; + comments_count: number; + comments_url: string; + created_at: string; + last_edited_at: null; + html_url: string; + node_id: string; + number: number; + pinned: boolean; + private: boolean; + team_url: string; + title: string; + updated_at: string; + url: string; + reactions: TeamsCreateDiscussionLegacyResponseDataReactions; +}; + +type TeamsGetDiscussionLegacyEndpoint = { /** * team_id parameter */ @@ -11974,13 +36972,65 @@ type TeamsGetDiscussionEndpoint = { */ discussion_number: number; }; -type TeamsGetDiscussionRequestOptions = { + +type TeamsGetDiscussionLegacyRequestOptions = { method: "GET"; - url: Url; + url: "/teams/:team_id/discussions/:discussion_number"; headers: RequestHeaders; request: RequestRequestOptions; }; -type TeamsUpdateDiscussionEndpoint = { +type TeamsGetDiscussionLegacyResponseDataReactions = { + url: string; + total_count: number; + "+1": number; + "-1": number; + laugh: number; + confused: number; + heart: number; + hooray: number; +}; +type TeamsGetDiscussionLegacyResponseDataAuthor = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type TeamsGetDiscussionLegacyResponseData = { + author: TeamsGetDiscussionLegacyResponseDataAuthor; + body: string; + body_html: string; + body_version: string; + comments_count: number; + comments_url: string; + created_at: string; + last_edited_at: null; + html_url: string; + node_id: string; + number: number; + pinned: boolean; + private: boolean; + team_url: string; + title: string; + updated_at: string; + url: string; + reactions: TeamsGetDiscussionLegacyResponseDataReactions; +}; + +type TeamsUpdateDiscussionLegacyEndpoint = { /** * team_id parameter */ @@ -11998,13 +37048,65 @@ type TeamsUpdateDiscussionEndpoint = { */ body?: string; }; -type TeamsUpdateDiscussionRequestOptions = { + +type TeamsUpdateDiscussionLegacyRequestOptions = { method: "PATCH"; - url: Url; + url: "/teams/:team_id/discussions/:discussion_number"; headers: RequestHeaders; request: RequestRequestOptions; }; -type TeamsDeleteDiscussionEndpoint = { +type TeamsUpdateDiscussionLegacyResponseDataReactions = { + url: string; + total_count: number; + "+1": number; + "-1": number; + laugh: number; + confused: number; + heart: number; + hooray: number; +}; +type TeamsUpdateDiscussionLegacyResponseDataAuthor = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type TeamsUpdateDiscussionLegacyResponseData = { + author: TeamsUpdateDiscussionLegacyResponseDataAuthor; + body: string; + body_html: string; + body_version: string; + comments_count: number; + comments_url: string; + created_at: string; + last_edited_at: string; + html_url: string; + node_id: string; + number: number; + pinned: boolean; + private: boolean; + team_url: string; + title: string; + updated_at: string; + url: string; + reactions: TeamsUpdateDiscussionLegacyResponseDataReactions; +}; + +type TeamsDeleteDiscussionLegacyEndpoint = { /** * team_id parameter */ @@ -12014,13 +37116,15 @@ type TeamsDeleteDiscussionEndpoint = { */ discussion_number: number; }; -type TeamsDeleteDiscussionRequestOptions = { + +type TeamsDeleteDiscussionLegacyRequestOptions = { method: "DELETE"; - url: Url; + url: "/teams/:team_id/discussions/:discussion_number"; headers: RequestHeaders; request: RequestRequestOptions; }; -type TeamsListDiscussionCommentsEndpoint = { + +type TeamsListDiscussionCommentsLegacyEndpoint = { /** * team_id parameter */ @@ -12042,13 +37146,63 @@ type TeamsListDiscussionCommentsEndpoint = { */ page?: number; }; -type TeamsListDiscussionCommentsRequestOptions = { + +type TeamsListDiscussionCommentsLegacyRequestOptions = { method: "GET"; - url: Url; + url: "/teams/:team_id/discussions/:discussion_number/comments"; headers: RequestHeaders; request: RequestRequestOptions; }; -type TeamsCreateDiscussionCommentEndpoint = { +type TeamsListDiscussionCommentsLegacyResponseDataItemReactions = { + url: string; + total_count: number; + "+1": number; + "-1": number; + laugh: number; + confused: number; + heart: number; + hooray: number; +}; +type TeamsListDiscussionCommentsLegacyResponseDataItemAuthor = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type TeamsListDiscussionCommentsLegacyResponseDataItem = { + author: TeamsListDiscussionCommentsLegacyResponseDataItemAuthor; + body: string; + body_html: string; + body_version: string; + created_at: string; + last_edited_at: null; + discussion_url: string; + html_url: string; + node_id: string; + number: number; + updated_at: string; + url: string; + reactions: TeamsListDiscussionCommentsLegacyResponseDataItemReactions; +}; +type TeamsListDiscussionCommentsLegacyResponseData = Array< + TeamsListDiscussionCommentsLegacyResponseDataItem +>; + +type TeamsCreateDiscussionCommentLegacyEndpoint = { /** * team_id parameter */ @@ -12062,13 +37216,60 @@ type TeamsCreateDiscussionCommentEndpoint = { */ body: string; }; -type TeamsCreateDiscussionCommentRequestOptions = { + +type TeamsCreateDiscussionCommentLegacyRequestOptions = { method: "POST"; - url: Url; + url: "/teams/:team_id/discussions/:discussion_number/comments"; headers: RequestHeaders; request: RequestRequestOptions; }; -type TeamsGetDiscussionCommentEndpoint = { +type TeamsCreateDiscussionCommentLegacyResponseDataReactions = { + url: string; + total_count: number; + "+1": number; + "-1": number; + laugh: number; + confused: number; + heart: number; + hooray: number; +}; +type TeamsCreateDiscussionCommentLegacyResponseDataAuthor = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type TeamsCreateDiscussionCommentLegacyResponseData = { + author: TeamsCreateDiscussionCommentLegacyResponseDataAuthor; + body: string; + body_html: string; + body_version: string; + created_at: string; + last_edited_at: null; + discussion_url: string; + html_url: string; + node_id: string; + number: number; + updated_at: string; + url: string; + reactions: TeamsCreateDiscussionCommentLegacyResponseDataReactions; +}; + +type TeamsGetDiscussionCommentLegacyEndpoint = { /** * team_id parameter */ @@ -12082,13 +37283,60 @@ type TeamsGetDiscussionCommentEndpoint = { */ comment_number: number; }; -type TeamsGetDiscussionCommentRequestOptions = { + +type TeamsGetDiscussionCommentLegacyRequestOptions = { method: "GET"; - url: Url; + url: "/teams/:team_id/discussions/:discussion_number/comments/:comment_number"; headers: RequestHeaders; request: RequestRequestOptions; }; -type TeamsUpdateDiscussionCommentEndpoint = { +type TeamsGetDiscussionCommentLegacyResponseDataReactions = { + url: string; + total_count: number; + "+1": number; + "-1": number; + laugh: number; + confused: number; + heart: number; + hooray: number; +}; +type TeamsGetDiscussionCommentLegacyResponseDataAuthor = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type TeamsGetDiscussionCommentLegacyResponseData = { + author: TeamsGetDiscussionCommentLegacyResponseDataAuthor; + body: string; + body_html: string; + body_version: string; + created_at: string; + last_edited_at: null; + discussion_url: string; + html_url: string; + node_id: string; + number: number; + updated_at: string; + url: string; + reactions: TeamsGetDiscussionCommentLegacyResponseDataReactions; +}; + +type TeamsUpdateDiscussionCommentLegacyEndpoint = { /** * team_id parameter */ @@ -12106,13 +37354,60 @@ type TeamsUpdateDiscussionCommentEndpoint = { */ body: string; }; -type TeamsUpdateDiscussionCommentRequestOptions = { + +type TeamsUpdateDiscussionCommentLegacyRequestOptions = { method: "PATCH"; - url: Url; + url: "/teams/:team_id/discussions/:discussion_number/comments/:comment_number"; headers: RequestHeaders; request: RequestRequestOptions; }; -type TeamsDeleteDiscussionCommentEndpoint = { +type TeamsUpdateDiscussionCommentLegacyResponseDataReactions = { + url: string; + total_count: number; + "+1": number; + "-1": number; + laugh: number; + confused: number; + heart: number; + hooray: number; +}; +type TeamsUpdateDiscussionCommentLegacyResponseDataAuthor = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type TeamsUpdateDiscussionCommentLegacyResponseData = { + author: TeamsUpdateDiscussionCommentLegacyResponseDataAuthor; + body: string; + body_html: string; + body_version: string; + created_at: string; + last_edited_at: string; + discussion_url: string; + html_url: string; + node_id: string; + number: number; + updated_at: string; + url: string; + reactions: TeamsUpdateDiscussionCommentLegacyResponseDataReactions; +}; + +type TeamsDeleteDiscussionCommentLegacyEndpoint = { /** * team_id parameter */ @@ -12126,13 +37421,15 @@ type TeamsDeleteDiscussionCommentEndpoint = { */ comment_number: number; }; -type TeamsDeleteDiscussionCommentRequestOptions = { + +type TeamsDeleteDiscussionCommentLegacyRequestOptions = { method: "DELETE"; - url: Url; + url: "/teams/:team_id/discussions/:discussion_number/comments/:comment_number"; headers: RequestHeaders; request: RequestRequestOptions; }; -type ReactionsListForTeamDiscussionCommentEndpoint = { + +type ReactionsListForTeamDiscussionCommentLegacyEndpoint = { /** * team_id parameter */ @@ -12165,14 +37462,46 @@ type ReactionsListForTeamDiscussionCommentEndpoint = { * Page number of the results to fetch. */ page?: number; -}; -type ReactionsListForTeamDiscussionCommentRequestOptions = { +} & RequiredPreview<"squirrel-girl">; + +type ReactionsListForTeamDiscussionCommentLegacyRequestOptions = { method: "GET"; - url: Url; + url: "/teams/:team_id/discussions/:discussion_number/comments/:comment_number/reactions"; headers: RequestHeaders; request: RequestRequestOptions; }; -type ReactionsCreateForTeamDiscussionCommentEndpoint = { +type ReactionsListForTeamDiscussionCommentLegacyResponseDataItemUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReactionsListForTeamDiscussionCommentLegacyResponseDataItem = { + id: number; + node_id: string; + user: ReactionsListForTeamDiscussionCommentLegacyResponseDataItemUser; + content: string; + created_at: string; +}; +type ReactionsListForTeamDiscussionCommentLegacyResponseData = Array< + ReactionsListForTeamDiscussionCommentLegacyResponseDataItem +>; + +type ReactionsCreateForTeamDiscussionCommentLegacyEndpoint = { /** * team_id parameter */ @@ -12197,14 +37526,43 @@ type ReactionsCreateForTeamDiscussionCommentEndpoint = { | "hooray" | "rocket" | "eyes"; -}; -type ReactionsCreateForTeamDiscussionCommentRequestOptions = { +} & RequiredPreview<"squirrel-girl">; + +type ReactionsCreateForTeamDiscussionCommentLegacyRequestOptions = { method: "POST"; - url: Url; + url: "/teams/:team_id/discussions/:discussion_number/comments/:comment_number/reactions"; headers: RequestHeaders; request: RequestRequestOptions; }; -type ReactionsListForTeamDiscussionEndpoint = { +type ReactionsCreateForTeamDiscussionCommentLegacyResponseDataUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReactionsCreateForTeamDiscussionCommentLegacyResponseData = { + id: number; + node_id: string; + user: ReactionsCreateForTeamDiscussionCommentLegacyResponseDataUser; + content: string; + created_at: string; +}; + +type ReactionsListForTeamDiscussionLegacyEndpoint = { /** * team_id parameter */ @@ -12233,14 +37591,46 @@ type ReactionsListForTeamDiscussionEndpoint = { * Page number of the results to fetch. */ page?: number; -}; -type ReactionsListForTeamDiscussionRequestOptions = { +} & RequiredPreview<"squirrel-girl">; + +type ReactionsListForTeamDiscussionLegacyRequestOptions = { method: "GET"; - url: Url; + url: "/teams/:team_id/discussions/:discussion_number/reactions"; headers: RequestHeaders; request: RequestRequestOptions; }; -type ReactionsCreateForTeamDiscussionEndpoint = { +type ReactionsListForTeamDiscussionLegacyResponseDataItemUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReactionsListForTeamDiscussionLegacyResponseDataItem = { + id: number; + node_id: string; + user: ReactionsListForTeamDiscussionLegacyResponseDataItemUser; + content: string; + created_at: string; +}; +type ReactionsListForTeamDiscussionLegacyResponseData = Array< + ReactionsListForTeamDiscussionLegacyResponseDataItem +>; + +type ReactionsCreateForTeamDiscussionLegacyEndpoint = { /** * team_id parameter */ @@ -12261,14 +37651,43 @@ type ReactionsCreateForTeamDiscussionEndpoint = { | "hooray" | "rocket" | "eyes"; -}; -type ReactionsCreateForTeamDiscussionRequestOptions = { +} & RequiredPreview<"squirrel-girl">; + +type ReactionsCreateForTeamDiscussionLegacyRequestOptions = { method: "POST"; - url: Url; + url: "/teams/:team_id/discussions/:discussion_number/reactions"; headers: RequestHeaders; request: RequestRequestOptions; }; -type TeamsListPendingInvitationsEndpoint = { +type ReactionsCreateForTeamDiscussionLegacyResponseDataUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReactionsCreateForTeamDiscussionLegacyResponseData = { + id: number; + node_id: string; + user: ReactionsCreateForTeamDiscussionLegacyResponseDataUser; + content: string; + created_at: string; +}; + +type TeamsListPendingInvitationsLegacyEndpoint = { /** * team_id parameter */ @@ -12282,13 +37701,48 @@ type TeamsListPendingInvitationsEndpoint = { */ page?: number; }; -type TeamsListPendingInvitationsRequestOptions = { + +type TeamsListPendingInvitationsLegacyRequestOptions = { method: "GET"; - url: Url; + url: "/teams/:team_id/invitations"; headers: RequestHeaders; request: RequestRequestOptions; }; -type TeamsListMembersEndpoint = { +type TeamsListPendingInvitationsLegacyResponseDataItemInviter = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type TeamsListPendingInvitationsLegacyResponseDataItem = { + id: number; + login: string; + email: string; + role: string; + created_at: string; + inviter: TeamsListPendingInvitationsLegacyResponseDataItemInviter; + team_count: number; + invitation_team_url: string; +}; +type TeamsListPendingInvitationsLegacyResponseData = Array< + TeamsListPendingInvitationsLegacyResponseDataItem +>; + +type TeamsListMembersLegacyEndpoint = { /** * team_id parameter */ @@ -12309,13 +37763,38 @@ type TeamsListMembersEndpoint = { */ page?: number; }; -type TeamsListMembersRequestOptions = { + +type TeamsListMembersLegacyRequestOptions = { method: "GET"; - url: Url; + url: "/teams/:team_id/members"; headers: RequestHeaders; request: RequestRequestOptions; }; -type TeamsGetMemberEndpoint = { +type TeamsListMembersLegacyResponseDataItem = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type TeamsListMembersLegacyResponseData = Array< + TeamsListMembersLegacyResponseDataItem +>; + +type TeamsGetMemberLegacyEndpoint = { /** * team_id parameter */ @@ -12325,13 +37804,15 @@ type TeamsGetMemberEndpoint = { */ username: string; }; -type TeamsGetMemberRequestOptions = { + +type TeamsGetMemberLegacyRequestOptions = { method: "GET"; - url: Url; + url: "/teams/:team_id/members/:username"; headers: RequestHeaders; request: RequestRequestOptions; }; -type TeamsAddMemberEndpoint = { + +type TeamsAddMemberLegacyEndpoint = { /** * team_id parameter */ @@ -12341,13 +37822,24 @@ type TeamsAddMemberEndpoint = { */ username: string; }; -type TeamsAddMemberRequestOptions = { + +type TeamsAddMemberLegacyRequestOptions = { method: "PUT"; - url: Url; + url: "/teams/:team_id/members/:username"; headers: RequestHeaders; request: RequestRequestOptions; }; -type TeamsRemoveMemberEndpoint = { +type TeamsAddMemberLegacyResponseDataErrorsItem = { + code: string; + field: string; + resource: string; +}; +type TeamsAddMemberLegacyResponseData = { + message: string; + errors: Array; +}; + +type TeamsRemoveMemberLegacyEndpoint = { /** * team_id parameter */ @@ -12357,13 +37849,15 @@ type TeamsRemoveMemberEndpoint = { */ username: string; }; -type TeamsRemoveMemberRequestOptions = { + +type TeamsRemoveMemberLegacyRequestOptions = { method: "DELETE"; - url: Url; + url: "/teams/:team_id/members/:username"; headers: RequestHeaders; request: RequestRequestOptions; }; -type TeamsGetMembershipEndpoint = { + +type TeamsGetMembershipLegacyEndpoint = { /** * team_id parameter */ @@ -12373,13 +37867,20 @@ type TeamsGetMembershipEndpoint = { */ username: string; }; -type TeamsGetMembershipRequestOptions = { + +type TeamsGetMembershipLegacyRequestOptions = { method: "GET"; - url: Url; + url: "/teams/:team_id/memberships/:username"; headers: RequestHeaders; request: RequestRequestOptions; }; -type TeamsAddOrUpdateMembershipEndpoint = { +type TeamsGetMembershipLegacyResponseData = { + url: string; + role: string; + state: string; +}; + +type TeamsAddOrUpdateMembershipLegacyEndpoint = { /** * team_id parameter */ @@ -12395,13 +37896,20 @@ type TeamsAddOrUpdateMembershipEndpoint = { */ role?: "member" | "maintainer"; }; -type TeamsAddOrUpdateMembershipRequestOptions = { + +type TeamsAddOrUpdateMembershipLegacyRequestOptions = { method: "PUT"; - url: Url; + url: "/teams/:team_id/memberships/:username"; headers: RequestHeaders; request: RequestRequestOptions; }; -type TeamsRemoveMembershipEndpoint = { +type TeamsAddOrUpdateMembershipLegacyResponseData = { + url: string; + role: string; + state: string; +}; + +type TeamsRemoveMembershipLegacyEndpoint = { /** * team_id parameter */ @@ -12411,13 +37919,15 @@ type TeamsRemoveMembershipEndpoint = { */ username: string; }; -type TeamsRemoveMembershipRequestOptions = { + +type TeamsRemoveMembershipLegacyRequestOptions = { method: "DELETE"; - url: Url; + url: "/teams/:team_id/memberships/:username"; headers: RequestHeaders; request: RequestRequestOptions; }; -type TeamsListProjectsEndpoint = { + +type TeamsListProjectsLegacyEndpoint = { /** * team_id parameter */ @@ -12430,14 +37940,62 @@ type TeamsListProjectsEndpoint = { * Page number of the results to fetch. */ page?: number; -}; -type TeamsListProjectsRequestOptions = { +} & RequiredPreview<"inertia">; + +type TeamsListProjectsLegacyRequestOptions = { method: "GET"; - url: Url; + url: "/teams/:team_id/projects"; headers: RequestHeaders; request: RequestRequestOptions; }; -type TeamsReviewProjectEndpoint = { +type TeamsListProjectsLegacyResponseDataItemPermissions = { + read: boolean; + write: boolean; + admin: boolean; +}; +type TeamsListProjectsLegacyResponseDataItemCreator = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type TeamsListProjectsLegacyResponseDataItem = { + owner_url: string; + url: string; + html_url: string; + columns_url: string; + id: number; + node_id: string; + name: string; + body: string; + number: number; + state: string; + creator: TeamsListProjectsLegacyResponseDataItemCreator; + created_at: string; + updated_at: string; + organization_permission: string; + private: boolean; + permissions: TeamsListProjectsLegacyResponseDataItemPermissions; +}; +type TeamsListProjectsLegacyResponseData = Array< + TeamsListProjectsLegacyResponseDataItem +>; + +type TeamsReviewProjectLegacyEndpoint = { /** * team_id parameter */ @@ -12446,14 +38004,59 @@ type TeamsReviewProjectEndpoint = { * project_id parameter */ project_id: number; -}; -type TeamsReviewProjectRequestOptions = { +} & RequiredPreview<"inertia">; + +type TeamsReviewProjectLegacyRequestOptions = { method: "GET"; - url: Url; + url: "/teams/:team_id/projects/:project_id"; headers: RequestHeaders; request: RequestRequestOptions; }; -type TeamsAddOrUpdateProjectEndpoint = { +type TeamsReviewProjectLegacyResponseDataPermissions = { + read: boolean; + write: boolean; + admin: boolean; +}; +type TeamsReviewProjectLegacyResponseDataCreator = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type TeamsReviewProjectLegacyResponseData = { + owner_url: string; + url: string; + html_url: string; + columns_url: string; + id: number; + node_id: string; + name: string; + body: string; + number: number; + state: string; + creator: TeamsReviewProjectLegacyResponseDataCreator; + created_at: string; + updated_at: string; + organization_permission: string; + private: boolean; + permissions: TeamsReviewProjectLegacyResponseDataPermissions; +}; + +type TeamsAddOrUpdateProjectLegacyEndpoint = { /** * team_id parameter */ @@ -12468,17 +38071,22 @@ type TeamsAddOrUpdateProjectEndpoint = { * \* `write` - team members can read and write, but not administer this project. * \* `admin` - team members can read, write and administer this project. * Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://developer.github.com/v3/#http-verbs)." - * **Note**: If you pass the `hellcat-preview` media type, you can promote—but not demote—a `permission` attribute inherited from a parent team. */ permission?: "read" | "write" | "admin"; -}; -type TeamsAddOrUpdateProjectRequestOptions = { +} & RequiredPreview<"inertia">; + +type TeamsAddOrUpdateProjectLegacyRequestOptions = { method: "PUT"; - url: Url; + url: "/teams/:team_id/projects/:project_id"; headers: RequestHeaders; request: RequestRequestOptions; }; -type TeamsRemoveProjectEndpoint = { +type TeamsAddOrUpdateProjectLegacyResponseData = { + message: string; + documentation_url: string; +}; + +type TeamsRemoveProjectLegacyEndpoint = { /** * team_id parameter */ @@ -12488,13 +38096,15 @@ type TeamsRemoveProjectEndpoint = { */ project_id: number; }; -type TeamsRemoveProjectRequestOptions = { + +type TeamsRemoveProjectLegacyRequestOptions = { method: "DELETE"; - url: Url; + url: "/teams/:team_id/projects/:project_id"; headers: RequestHeaders; request: RequestRequestOptions; }; -type TeamsListReposEndpoint = { + +type TeamsListReposLegacyEndpoint = { /** * team_id parameter */ @@ -12508,13 +38118,130 @@ type TeamsListReposEndpoint = { */ page?: number; }; -type TeamsListReposRequestOptions = { + +type TeamsListReposLegacyRequestOptions = { method: "GET"; - url: Url; + url: "/teams/:team_id/repos"; headers: RequestHeaders; request: RequestRequestOptions; }; -type TeamsCheckManagesRepoEndpoint = { +type TeamsListReposLegacyResponseDataItemLicense = { + key: string; + name: string; + spdx_id: string; + url: string; + node_id: string; +}; +type TeamsListReposLegacyResponseDataItemPermissions = { + admin: boolean; + push: boolean; + pull: boolean; +}; +type TeamsListReposLegacyResponseDataItemOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type TeamsListReposLegacyResponseDataItem = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: TeamsListReposLegacyResponseDataItemOwner; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: null; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: Array; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: TeamsListReposLegacyResponseDataItemPermissions; + template_repository: null; + temp_clone_token: string; + subscribers_count: number; + network_count: number; + license: TeamsListReposLegacyResponseDataItemLicense; +}; +type TeamsListReposLegacyResponseData = Array< + TeamsListReposLegacyResponseDataItem +>; + +type TeamsCheckManagesRepoLegacyEndpoint = { /** * team_id parameter */ @@ -12528,13 +38255,262 @@ type TeamsCheckManagesRepoEndpoint = { */ repo: string; }; -type TeamsCheckManagesRepoRequestOptions = { + +type TeamsCheckManagesRepoLegacyRequestOptions = { method: "GET"; - url: Url; + url: "/teams/:team_id/repos/:owner/:repo"; headers: RequestHeaders; request: RequestRequestOptions; }; -type TeamsAddOrUpdateRepoEndpoint = { +type TeamsCheckManagesRepoLegacyResponseDataPermissions = { + pull: boolean; + triage: boolean; + push: boolean; + maintain: boolean; + admin: boolean; +}; +type TeamsCheckManagesRepoLegacyResponseDataSourcePermissions = { + admin: boolean; + push: boolean; + pull: boolean; +}; +type TeamsCheckManagesRepoLegacyResponseDataSourceOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type TeamsCheckManagesRepoLegacyResponseDataSource = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: TeamsCheckManagesRepoLegacyResponseDataSourceOwner; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: null; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: Array; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: TeamsCheckManagesRepoLegacyResponseDataSourcePermissions; + allow_rebase_merge: boolean; + template_repository: null; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; +}; +type TeamsCheckManagesRepoLegacyResponseDataParentPermissions = { + admin: boolean; + push: boolean; + pull: boolean; +}; +type TeamsCheckManagesRepoLegacyResponseDataParentOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type TeamsCheckManagesRepoLegacyResponseDataParent = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: TeamsCheckManagesRepoLegacyResponseDataParentOwner; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: null; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: Array; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: TeamsCheckManagesRepoLegacyResponseDataParentPermissions; + allow_rebase_merge: boolean; + template_repository: null; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; +}; +type TeamsCheckManagesRepoLegacyResponseDataOrganization = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type TeamsCheckManagesRepoLegacyResponseData = { + organization: TeamsCheckManagesRepoLegacyResponseDataOrganization; + parent: TeamsCheckManagesRepoLegacyResponseDataParent; + source: TeamsCheckManagesRepoLegacyResponseDataSource; + permissions: TeamsCheckManagesRepoLegacyResponseDataPermissions; +}; + +type TeamsAddOrUpdateRepoLegacyEndpoint = { /** * team_id parameter */ @@ -12554,17 +38530,18 @@ type TeamsAddOrUpdateRepoEndpoint = { * \* `admin` - team members can pull, push and administer this repository. * * If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository. - * **Note**: If you pass the `hellcat-preview` media type, you can promote—but not demote—a `permission` attribute inherited through a parent team. */ permission?: "pull" | "push" | "admin"; }; -type TeamsAddOrUpdateRepoRequestOptions = { + +type TeamsAddOrUpdateRepoLegacyRequestOptions = { method: "PUT"; - url: Url; + url: "/teams/:team_id/repos/:owner/:repo"; headers: RequestHeaders; request: RequestRequestOptions; }; -type TeamsRemoveRepoEndpoint = { + +type TeamsRemoveRepoLegacyEndpoint = { /** * team_id parameter */ @@ -12578,25 +38555,37 @@ type TeamsRemoveRepoEndpoint = { */ repo: string; }; -type TeamsRemoveRepoRequestOptions = { + +type TeamsRemoveRepoLegacyRequestOptions = { method: "DELETE"; - url: Url; + url: "/teams/:team_id/repos/:owner/:repo"; headers: RequestHeaders; request: RequestRequestOptions; }; -type TeamsListIdPGroupsEndpoint = { + +type TeamsListIdPGroupsForLegacyEndpoint = { /** * team_id parameter */ team_id: number; }; -type TeamsListIdPGroupsRequestOptions = { + +type TeamsListIdPGroupsForLegacyRequestOptions = { method: "GET"; - url: Url; + url: "/teams/:team_id/team-sync/group-mappings"; headers: RequestHeaders; request: RequestRequestOptions; }; -type TeamsCreateOrUpdateIdPGroupConnectionsEndpoint = { +type TeamsListIdPGroupsForLegacyResponseDataGroupsItem = { + group_id: string; + group_name: string; + group_description: string; +}; +type TeamsListIdPGroupsForLegacyResponseData = { + groups: Array; +}; + +type TeamsCreateOrUpdateIdPGroupConnectionsLegacyEndpoint = { /** * team_id parameter */ @@ -12604,15 +38593,27 @@ type TeamsCreateOrUpdateIdPGroupConnectionsEndpoint = { /** * The IdP groups you want to connect to a GitHub team. When updating, the new `groups` object will replace the original one. You must include any existing groups that you don't want to remove. */ - groups: TeamsCreateOrUpdateIdPGroupConnectionsParamsGroups[]; + groups: TeamsCreateOrUpdateIdPGroupConnectionsLegacyParamsGroups[]; }; -type TeamsCreateOrUpdateIdPGroupConnectionsRequestOptions = { + +type TeamsCreateOrUpdateIdPGroupConnectionsLegacyRequestOptions = { method: "PATCH"; - url: Url; + url: "/teams/:team_id/team-sync/group-mappings"; headers: RequestHeaders; request: RequestRequestOptions; }; -type TeamsListChildEndpoint = { +type TeamsCreateOrUpdateIdPGroupConnectionsLegacyResponseDataGroupsItem = { + group_id: string; + group_name: string; + group_description: string; +}; +type TeamsCreateOrUpdateIdPGroupConnectionsLegacyResponseData = { + groups: Array< + TeamsCreateOrUpdateIdPGroupConnectionsLegacyResponseDataGroupsItem + >; +}; + +type TeamsListChildLegacyEndpoint = { /** * team_id parameter */ @@ -12626,19 +38627,98 @@ type TeamsListChildEndpoint = { */ page?: number; }; -type TeamsListChildRequestOptions = { + +type TeamsListChildLegacyRequestOptions = { method: "GET"; - url: Url; + url: "/teams/:team_id/teams"; headers: RequestHeaders; request: RequestRequestOptions; }; +type TeamsListChildLegacyResponseDataItemParent = { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; +}; +type TeamsListChildLegacyResponseDataItem = { + id: number; + node_id: string; + url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: TeamsListChildLegacyResponseDataItemParent; +}; +type TeamsListChildLegacyResponseData = Array< + TeamsListChildLegacyResponseDataItem +>; + type UsersGetAuthenticatedEndpoint = {}; + type UsersGetAuthenticatedRequestOptions = { method: "GET"; - url: Url; + url: "/user"; headers: RequestHeaders; request: RequestRequestOptions; }; +type UsersGetAuthenticatedResponseDataPlan = { + name: string; + space: number; + private_repos: number; + collaborators: number; +}; +type UsersGetAuthenticatedResponseData = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + name: string; + company: string; + blog: string; + location: string; + email: string; + hireable: boolean; + bio: string; + public_repos: number; + public_gists: number; + followers: number; + following: number; + created_at: string; + updated_at: string; + private_gists?: number; + total_private_repos?: number; + owned_private_repos?: number; + disk_usage?: number; + collaborators?: number; + two_factor_authentication?: boolean; + plan?: UsersGetAuthenticatedResponseDataPlan; +}; + type UsersUpdateAuthenticatedEndpoint = { /** * The new name of the user. @@ -12669,55 +38749,132 @@ type UsersUpdateAuthenticatedEndpoint = { */ bio?: string; }; + type UsersUpdateAuthenticatedRequestOptions = { method: "PATCH"; - url: Url; + url: "/user"; headers: RequestHeaders; request: RequestRequestOptions; }; +type UsersUpdateAuthenticatedResponseDataPlan = { + name: string; + space: number; + private_repos: number; + collaborators: number; +}; +type UsersUpdateAuthenticatedResponseData = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + name: string; + company: string; + blog: string; + location: string; + email: string; + hireable: boolean; + bio: string; + public_repos: number; + public_gists: number; + followers: number; + following: number; + created_at: string; + updated_at: string; + private_gists: number; + total_private_repos: number; + owned_private_repos: number; + disk_usage: number; + collaborators: number; + two_factor_authentication: boolean; + plan: UsersUpdateAuthenticatedResponseDataPlan; +}; + type UsersListBlockedEndpoint = {}; + type UsersListBlockedRequestOptions = { method: "GET"; - url: Url; + url: "/user/blocks"; headers: RequestHeaders; request: RequestRequestOptions; }; +type UsersListBlockedResponseDataItem = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type UsersListBlockedResponseData = Array; + type UsersCheckBlockedEndpoint = { /** * username parameter */ username: string; }; + type UsersCheckBlockedRequestOptions = { method: "GET"; - url: Url; + url: "/user/blocks/:username"; headers: RequestHeaders; request: RequestRequestOptions; }; + type UsersBlockEndpoint = { /** * username parameter */ username: string; }; + type UsersBlockRequestOptions = { method: "PUT"; - url: Url; + url: "/user/blocks/:username"; headers: RequestHeaders; request: RequestRequestOptions; }; + type UsersUnblockEndpoint = { /** * username parameter */ username: string; }; + type UsersUnblockRequestOptions = { method: "DELETE"; - url: Url; + url: "/user/blocks/:username"; headers: RequestHeaders; request: RequestRequestOptions; }; + type UsersTogglePrimaryEmailVisibilityEndpoint = { /** * Specify the _primary_ email address that needs a visibility change. @@ -12728,12 +38885,23 @@ type UsersTogglePrimaryEmailVisibilityEndpoint = { */ visibility: string; }; + type UsersTogglePrimaryEmailVisibilityRequestOptions = { method: "PATCH"; - url: Url; + url: "/user/email/visibility"; headers: RequestHeaders; request: RequestRequestOptions; }; +type UsersTogglePrimaryEmailVisibilityResponseDataItem = { + email: string; + primary: boolean; + verified: boolean; + visibility: string; +}; +type UsersTogglePrimaryEmailVisibilityResponseData = Array< + UsersTogglePrimaryEmailVisibilityResponseDataItem +>; + type UsersListEmailsEndpoint = { /** * Results per page (max 100) @@ -12744,36 +38912,56 @@ type UsersListEmailsEndpoint = { */ page?: number; }; + type UsersListEmailsRequestOptions = { method: "GET"; - url: Url; + url: "/user/emails"; headers: RequestHeaders; request: RequestRequestOptions; }; +type UsersListEmailsResponseDataItem = { + email: string; + verified: boolean; + primary: boolean; + visibility: string; +}; +type UsersListEmailsResponseData = Array; + type UsersAddEmailsEndpoint = { /** * Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key. */ emails: string[]; }; + type UsersAddEmailsRequestOptions = { method: "POST"; - url: Url; + url: "/user/emails"; headers: RequestHeaders; request: RequestRequestOptions; }; +type UsersAddEmailsResponseDataItem = { + email: string; + primary: boolean; + verified: boolean; + visibility: string | null; +}; +type UsersAddEmailsResponseData = Array; + type UsersDeleteEmailsEndpoint = { /** * Deletes one or more email addresses from your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key. */ emails: string[]; }; + type UsersDeleteEmailsRequestOptions = { method: "DELETE"; - url: Url; + url: "/user/emails"; headers: RequestHeaders; request: RequestRequestOptions; }; + type UsersListFollowersForAuthenticatedUserEndpoint = { /** * Results per page (max 100) @@ -12784,13 +38972,38 @@ type UsersListFollowersForAuthenticatedUserEndpoint = { */ page?: number; }; + type UsersListFollowersForAuthenticatedUserRequestOptions = { method: "GET"; - url: Url; + url: "/user/followers"; headers: RequestHeaders; request: RequestRequestOptions; }; -type UsersListFollowingForAuthenticatedUserEndpoint = { +type UsersListFollowersForAuthenticatedUserResponseDataItem = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type UsersListFollowersForAuthenticatedUserResponseData = Array< + UsersListFollowersForAuthenticatedUserResponseDataItem +>; + +type UsersListFollowedByAuthenticatedEndpoint = { /** * Results per page (max 100) */ @@ -12800,48 +39013,79 @@ type UsersListFollowingForAuthenticatedUserEndpoint = { */ page?: number; }; -type UsersListFollowingForAuthenticatedUserRequestOptions = { + +type UsersListFollowedByAuthenticatedRequestOptions = { method: "GET"; - url: Url; + url: "/user/following"; headers: RequestHeaders; request: RequestRequestOptions; }; +type UsersListFollowedByAuthenticatedResponseDataItem = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type UsersListFollowedByAuthenticatedResponseData = Array< + UsersListFollowedByAuthenticatedResponseDataItem +>; + type UsersCheckFollowingEndpoint = { /** * username parameter */ username: string; }; + type UsersCheckFollowingRequestOptions = { method: "GET"; - url: Url; + url: "/user/following/:username"; headers: RequestHeaders; request: RequestRequestOptions; }; + type UsersFollowEndpoint = { /** * username parameter */ username: string; }; + type UsersFollowRequestOptions = { method: "PUT"; - url: Url; + url: "/user/following/:username"; headers: RequestHeaders; request: RequestRequestOptions; }; + type UsersUnfollowEndpoint = { /** * username parameter */ username: string; }; + type UsersUnfollowRequestOptions = { method: "DELETE"; - url: Url; + url: "/user/following/:username"; headers: RequestHeaders; request: RequestRequestOptions; }; + type UsersListGpgKeysEndpoint = { /** * Results per page (max 100) @@ -12852,48 +39096,153 @@ type UsersListGpgKeysEndpoint = { */ page?: number; }; + type UsersListGpgKeysRequestOptions = { method: "GET"; - url: Url; + url: "/user/gpg_keys"; headers: RequestHeaders; request: RequestRequestOptions; }; +type UsersListGpgKeysResponseDataItemSubkeysItem = { + id: number; + primary_key_id: number; + key_id: string; + public_key: string; + emails: Array; + subkeys: Array; + can_sign: boolean; + can_encrypt_comms: boolean; + can_encrypt_storage: boolean; + can_certify: boolean; + created_at: string; + expires_at: null; +}; +type UsersListGpgKeysResponseDataItemEmailsItem = { + email: string; + verified: boolean; +}; +type UsersListGpgKeysResponseDataItem = { + id: number; + primary_key_id: null; + key_id: string; + public_key: string; + emails: Array; + subkeys: Array; + can_sign: boolean; + can_encrypt_comms: boolean; + can_encrypt_storage: boolean; + can_certify: boolean; + created_at: string; + expires_at: null; +}; +type UsersListGpgKeysResponseData = Array; + type UsersCreateGpgKeyEndpoint = { /** * Your GPG key, generated in ASCII-armored format. See "[Generating a new GPG key](https://help.github.com/articles/generating-a-new-gpg-key/)" for help creating a GPG key. */ armored_public_key?: string; }; + type UsersCreateGpgKeyRequestOptions = { method: "POST"; - url: Url; + url: "/user/gpg_keys"; headers: RequestHeaders; request: RequestRequestOptions; }; +type UsersCreateGpgKeyResponseDataSubkeysItem = { + id: number; + primary_key_id: number; + key_id: string; + public_key: string; + emails: Array; + subkeys: Array; + can_sign: boolean; + can_encrypt_comms: boolean; + can_encrypt_storage: boolean; + can_certify: boolean; + created_at: string; + expires_at: null; +}; +type UsersCreateGpgKeyResponseDataEmailsItem = { + email: string; + verified: boolean; +}; +type UsersCreateGpgKeyResponseData = { + id: number; + primary_key_id: null; + key_id: string; + public_key: string; + emails: Array; + subkeys: Array; + can_sign: boolean; + can_encrypt_comms: boolean; + can_encrypt_storage: boolean; + can_certify: boolean; + created_at: string; + expires_at: null; +}; + type UsersGetGpgKeyEndpoint = { /** * gpg_key_id parameter */ gpg_key_id: number; }; + type UsersGetGpgKeyRequestOptions = { method: "GET"; - url: Url; + url: "/user/gpg_keys/:gpg_key_id"; headers: RequestHeaders; request: RequestRequestOptions; }; +type UsersGetGpgKeyResponseDataSubkeysItem = { + id: number; + primary_key_id: number; + key_id: string; + public_key: string; + emails: Array; + subkeys: Array; + can_sign: boolean; + can_encrypt_comms: boolean; + can_encrypt_storage: boolean; + can_certify: boolean; + created_at: string; + expires_at: null; +}; +type UsersGetGpgKeyResponseDataEmailsItem = { + email: string; + verified: boolean; +}; +type UsersGetGpgKeyResponseData = { + id: number; + primary_key_id: null; + key_id: string; + public_key: string; + emails: Array; + subkeys: Array; + can_sign: boolean; + can_encrypt_comms: boolean; + can_encrypt_storage: boolean; + can_certify: boolean; + created_at: string; + expires_at: null; +}; + type UsersDeleteGpgKeyEndpoint = { /** * gpg_key_id parameter */ gpg_key_id: number; }; + type UsersDeleteGpgKeyRequestOptions = { method: "DELETE"; - url: Url; + url: "/user/gpg_keys/:gpg_key_id"; headers: RequestHeaders; request: RequestRequestOptions; }; + type AppsListInstallationsForAuthenticatedUserEndpoint = { /** * Results per page (max 100) @@ -12903,13 +39252,65 @@ type AppsListInstallationsForAuthenticatedUserEndpoint = { * Page number of the results to fetch. */ page?: number; -}; +} & RequiredPreview<"machine-man">; + type AppsListInstallationsForAuthenticatedUserRequestOptions = { method: "GET"; - url: Url; + url: "/user/installations"; headers: RequestHeaders; request: RequestRequestOptions; }; +type AppsListInstallationsForAuthenticatedUserResponseDataInstallationsItemPermissions = { + metadata: string; + contents: string; + issues: string; + single_file: string; +}; +type AppsListInstallationsForAuthenticatedUserResponseDataInstallationsItemAccount = { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url?: string; + issues_url?: string; + members_url?: string; + public_members_url?: string; + avatar_url: string; + description?: string; + gravatar_id?: string; + html_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + starred_url?: string; + subscriptions_url?: string; + organizations_url?: string; + received_events_url?: string; + type?: string; + site_admin?: boolean; +}; +type AppsListInstallationsForAuthenticatedUserResponseDataInstallationsItem = { + id: number; + account: AppsListInstallationsForAuthenticatedUserResponseDataInstallationsItemAccount; + access_tokens_url: string; + repositories_url: string; + html_url: string; + app_id: number; + target_id: number; + target_type: string; + permissions: AppsListInstallationsForAuthenticatedUserResponseDataInstallationsItemPermissions; + events: Array; + single_file_name: string; +}; +type AppsListInstallationsForAuthenticatedUserResponseData = { + total_count: number; + installations: Array< + AppsListInstallationsForAuthenticatedUserResponseDataInstallationsItem + >; +}; + type AppsListInstallationReposForAuthenticatedUserEndpoint = { /** * installation_id parameter @@ -12923,13 +39324,128 @@ type AppsListInstallationReposForAuthenticatedUserEndpoint = { * Page number of the results to fetch. */ page?: number; -}; +} & RequiredPreview<"machine-man">; + type AppsListInstallationReposForAuthenticatedUserRequestOptions = { method: "GET"; - url: Url; + url: "/user/installations/:installation_id/repositories"; headers: RequestHeaders; request: RequestRequestOptions; }; +type AppsListInstallationReposForAuthenticatedUserResponseDataRepositoriesItemPermissions = { + admin: boolean; + push: boolean; + pull: boolean; +}; +type AppsListInstallationReposForAuthenticatedUserResponseDataRepositoriesItemOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type AppsListInstallationReposForAuthenticatedUserResponseDataRepositoriesItem = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: AppsListInstallationReposForAuthenticatedUserResponseDataRepositoriesItemOwner; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: null; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: Array; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: AppsListInstallationReposForAuthenticatedUserResponseDataRepositoriesItemPermissions; + allow_rebase_merge: boolean; + template_repository: null; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; +}; +type AppsListInstallationReposForAuthenticatedUserResponseData = { + total_count: number; + repositories: Array< + AppsListInstallationReposForAuthenticatedUserResponseDataRepositoriesItem + >; +}; + type AppsAddRepoToInstallationEndpoint = { /** * installation_id parameter @@ -12939,13 +39455,15 @@ type AppsAddRepoToInstallationEndpoint = { * repository_id parameter */ repository_id: number; -}; +} & RequiredPreview<"machine-man">; + type AppsAddRepoToInstallationRequestOptions = { method: "PUT"; - url: Url; + url: "/user/installations/:installation_id/repositories/:repository_id"; headers: RequestHeaders; request: RequestRequestOptions; }; + type AppsRemoveRepoFromInstallationEndpoint = { /** * installation_id parameter @@ -12955,13 +39473,15 @@ type AppsRemoveRepoFromInstallationEndpoint = { * repository_id parameter */ repository_id: number; -}; +} & RequiredPreview<"machine-man">; + type AppsRemoveRepoFromInstallationRequestOptions = { method: "DELETE"; - url: Url; + url: "/user/installations/:installation_id/repositories/:repository_id"; headers: RequestHeaders; request: RequestRequestOptions; }; + type IssuesListForAuthenticatedUserEndpoint = { /** * Indicates which sorts of issues to return. Can be one of: @@ -13001,12 +39521,264 @@ type IssuesListForAuthenticatedUserEndpoint = { */ page?: number; }; + type IssuesListForAuthenticatedUserRequestOptions = { method: "GET"; - url: Url; + url: "/user/issues"; headers: RequestHeaders; request: RequestRequestOptions; }; +type IssuesListForAuthenticatedUserResponseDataItemRepositoryPermissions = { + admin: boolean; + push: boolean; + pull: boolean; +}; +type IssuesListForAuthenticatedUserResponseDataItemRepositoryOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type IssuesListForAuthenticatedUserResponseDataItemRepository = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: IssuesListForAuthenticatedUserResponseDataItemRepositoryOwner; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: null; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: Array; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: IssuesListForAuthenticatedUserResponseDataItemRepositoryPermissions; + allow_rebase_merge: boolean; + template_repository: null; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; +}; +type IssuesListForAuthenticatedUserResponseDataItemPullRequest = { + url: string; + html_url: string; + diff_url: string; + patch_url: string; +}; +type IssuesListForAuthenticatedUserResponseDataItemMilestoneCreator = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type IssuesListForAuthenticatedUserResponseDataItemMilestone = { + url: string; + html_url: string; + labels_url: string; + id: number; + node_id: string; + number: number; + state: string; + title: string; + description: string; + creator: IssuesListForAuthenticatedUserResponseDataItemMilestoneCreator; + open_issues: number; + closed_issues: number; + created_at: string; + updated_at: string; + closed_at: string; + due_on: string; +}; +type IssuesListForAuthenticatedUserResponseDataItemAssigneesItem = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type IssuesListForAuthenticatedUserResponseDataItemAssignee = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type IssuesListForAuthenticatedUserResponseDataItemLabelsItem = { + id: number; + node_id: string; + url: string; + name: string; + description: string; + color: string; + default: boolean; +}; +type IssuesListForAuthenticatedUserResponseDataItemUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type IssuesListForAuthenticatedUserResponseDataItem = { + id: number; + node_id: string; + url: string; + repository_url: string; + labels_url: string; + comments_url: string; + events_url: string; + html_url: string; + number: number; + state: string; + title: string; + body: string; + user: IssuesListForAuthenticatedUserResponseDataItemUser; + labels: Array; + assignee: IssuesListForAuthenticatedUserResponseDataItemAssignee; + assignees: Array; + milestone: IssuesListForAuthenticatedUserResponseDataItemMilestone; + locked: boolean; + active_lock_reason: string; + comments: number; + pull_request: IssuesListForAuthenticatedUserResponseDataItemPullRequest; + closed_at: null; + created_at: string; + updated_at: string; + repository: IssuesListForAuthenticatedUserResponseDataItemRepository; +}; +type IssuesListForAuthenticatedUserResponseData = Array< + IssuesListForAuthenticatedUserResponseDataItem +>; + type UsersListPublicKeysEndpoint = { /** * Results per page (max 100) @@ -13017,12 +39789,18 @@ type UsersListPublicKeysEndpoint = { */ page?: number; }; + type UsersListPublicKeysRequestOptions = { method: "GET"; - url: Url; + url: "/user/keys"; headers: RequestHeaders; request: RequestRequestOptions; }; +type UsersListPublicKeysResponseDataItem = { key_id: string; key: string }; +type UsersListPublicKeysResponseData = Array< + UsersListPublicKeysResponseDataItem +>; + type UsersCreatePublicKeyEndpoint = { /** * A descriptive name for the new key. Use a name that will help you recognize this key in your GitHub account. For example, if you're using a personal Mac, you might call this key "Personal MacBook Air". @@ -13033,37 +39811,45 @@ type UsersCreatePublicKeyEndpoint = { */ key?: string; }; + type UsersCreatePublicKeyRequestOptions = { method: "POST"; - url: Url; + url: "/user/keys"; headers: RequestHeaders; request: RequestRequestOptions; }; +type UsersCreatePublicKeyResponseData = { key_id: string; key: string }; + type UsersGetPublicKeyEndpoint = { /** * key_id parameter */ key_id: number; }; + type UsersGetPublicKeyRequestOptions = { method: "GET"; - url: Url; + url: "/user/keys/:key_id"; headers: RequestHeaders; request: RequestRequestOptions; }; +type UsersGetPublicKeyResponseData = { key_id: string; key: string }; + type UsersDeletePublicKeyEndpoint = { /** * key_id parameter */ key_id: number; }; + type UsersDeletePublicKeyRequestOptions = { method: "DELETE"; - url: Url; + url: "/user/keys/:key_id"; headers: RequestHeaders; request: RequestRequestOptions; }; -type AppsListMarketplacePurchasesForAuthenticatedUserEndpoint = { + +type AppsListSubscriptionsForAuthenticatedUserEndpoint = { /** * Results per page (max 100) */ @@ -13073,13 +39859,51 @@ type AppsListMarketplacePurchasesForAuthenticatedUserEndpoint = { */ page?: number; }; -type AppsListMarketplacePurchasesForAuthenticatedUserRequestOptions = { + +type AppsListSubscriptionsForAuthenticatedUserRequestOptions = { method: "GET"; - url: Url; + url: "/user/marketplace_purchases"; headers: RequestHeaders; request: RequestRequestOptions; }; -type AppsListMarketplacePurchasesForAuthenticatedUserStubbedEndpoint = { +type AppsListSubscriptionsForAuthenticatedUserResponseDataItemPlan = { + url: string; + accounts_url: string; + id: number; + number: number; + name: string; + description: string; + monthly_price_in_cents: number; + yearly_price_in_cents: number; + price_model: string; + has_free_trial: boolean; + unit_name: null; + state: string; + bullets: Array; +}; +type AppsListSubscriptionsForAuthenticatedUserResponseDataItemAccount = { + login: string; + id: number; + url: string; + email: null; + organization_billing_email: string; + type: string; +}; +type AppsListSubscriptionsForAuthenticatedUserResponseDataItem = { + billing_cycle: string; + next_billing_date: string; + unit_count: null; + on_free_trial: boolean; + free_trial_ends_on: string; + updated_at: string; + account: AppsListSubscriptionsForAuthenticatedUserResponseDataItemAccount; + plan: AppsListSubscriptionsForAuthenticatedUserResponseDataItemPlan; +}; +type AppsListSubscriptionsForAuthenticatedUserResponseData = Array< + AppsListSubscriptionsForAuthenticatedUserResponseDataItem +>; + +type AppsListSubscriptionsForAuthenticatedUserStubbedEndpoint = { /** * Results per page (max 100) */ @@ -13089,12 +39913,50 @@ type AppsListMarketplacePurchasesForAuthenticatedUserStubbedEndpoint = { */ page?: number; }; -type AppsListMarketplacePurchasesForAuthenticatedUserStubbedRequestOptions = { + +type AppsListSubscriptionsForAuthenticatedUserStubbedRequestOptions = { method: "GET"; - url: Url; + url: "/user/marketplace_purchases/stubbed"; headers: RequestHeaders; request: RequestRequestOptions; }; +type AppsListSubscriptionsForAuthenticatedUserStubbedResponseDataItemPlan = { + url: string; + accounts_url: string; + id: number; + number: number; + name: string; + description: string; + monthly_price_in_cents: number; + yearly_price_in_cents: number; + price_model: string; + has_free_trial: boolean; + unit_name: null; + state: string; + bullets: Array; +}; +type AppsListSubscriptionsForAuthenticatedUserStubbedResponseDataItemAccount = { + login: string; + id: number; + url: string; + email: null; + organization_billing_email: string; + type: string; +}; +type AppsListSubscriptionsForAuthenticatedUserStubbedResponseDataItem = { + billing_cycle: string; + next_billing_date: string; + unit_count: null; + on_free_trial: boolean; + free_trial_ends_on: string; + updated_at: string; + account: AppsListSubscriptionsForAuthenticatedUserStubbedResponseDataItemAccount; + plan: AppsListSubscriptionsForAuthenticatedUserStubbedResponseDataItemPlan; +}; +type AppsListSubscriptionsForAuthenticatedUserStubbedResponseData = Array< + AppsListSubscriptionsForAuthenticatedUserStubbedResponseDataItem +>; + type OrgsListMembershipsEndpoint = { /** * Indicates the state of the memberships to return. Can be either `active` or `pending`. If not specified, the API returns both active and pending memberships. @@ -13109,24 +39971,115 @@ type OrgsListMembershipsEndpoint = { */ page?: number; }; + type OrgsListMembershipsRequestOptions = { method: "GET"; - url: Url; + url: "/user/memberships/orgs"; headers: RequestHeaders; request: RequestRequestOptions; }; +type OrgsListMembershipsResponseDataItemUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type OrgsListMembershipsResponseDataItemOrganization = { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; +}; +type OrgsListMembershipsResponseDataItem = { + url: string; + state: string; + role: string; + organization_url: string; + organization: OrgsListMembershipsResponseDataItemOrganization; + user: OrgsListMembershipsResponseDataItemUser; +}; +type OrgsListMembershipsResponseData = Array< + OrgsListMembershipsResponseDataItem +>; + type OrgsGetMembershipForAuthenticatedUserEndpoint = { /** * org parameter */ org: string; }; + type OrgsGetMembershipForAuthenticatedUserRequestOptions = { method: "GET"; - url: Url; + url: "/user/memberships/orgs/:org"; headers: RequestHeaders; request: RequestRequestOptions; }; +type OrgsGetMembershipForAuthenticatedUserResponseDataUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type OrgsGetMembershipForAuthenticatedUserResponseDataOrganization = { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; +}; +type OrgsGetMembershipForAuthenticatedUserResponseData = { + url: string; + state: string; + role: string; + organization_url: string; + organization: OrgsGetMembershipForAuthenticatedUserResponseDataOrganization; + user: OrgsGetMembershipForAuthenticatedUserResponseDataUser; +}; + type OrgsUpdateMembershipEndpoint = { /** * org parameter @@ -13137,12 +40090,56 @@ type OrgsUpdateMembershipEndpoint = { */ state: "active"; }; + type OrgsUpdateMembershipRequestOptions = { method: "PATCH"; - url: Url; + url: "/user/memberships/orgs/:org"; headers: RequestHeaders; request: RequestRequestOptions; }; +type OrgsUpdateMembershipResponseDataUser = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type OrgsUpdateMembershipResponseDataOrganization = { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; +}; +type OrgsUpdateMembershipResponseData = { + url: string; + state: string; + role: string; + organization_url: string; + organization: OrgsUpdateMembershipResponseDataOrganization; + user: OrgsUpdateMembershipResponseDataUser; +}; + type MigrationsStartForAuthenticatedUserEndpoint = { /** * An array of repositories to include in the migration. @@ -13157,12 +40154,155 @@ type MigrationsStartForAuthenticatedUserEndpoint = { */ exclude_attachments?: boolean; }; + type MigrationsStartForAuthenticatedUserRequestOptions = { method: "POST"; - url: Url; + url: "/user/migrations"; headers: RequestHeaders; request: RequestRequestOptions; }; +type MigrationsStartForAuthenticatedUserResponseDataRepositoriesItemPermissions = { + admin: boolean; + push: boolean; + pull: boolean; +}; +type MigrationsStartForAuthenticatedUserResponseDataRepositoriesItemOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type MigrationsStartForAuthenticatedUserResponseDataRepositoriesItem = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: MigrationsStartForAuthenticatedUserResponseDataRepositoriesItemOwner; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: null; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: Array; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: MigrationsStartForAuthenticatedUserResponseDataRepositoriesItemPermissions; + allow_rebase_merge: boolean; + template_repository: null; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; +}; +type MigrationsStartForAuthenticatedUserResponseDataOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type MigrationsStartForAuthenticatedUserResponseData = { + id: number; + owner: MigrationsStartForAuthenticatedUserResponseDataOwner; + guid: string; + state: string; + lock_repositories: boolean; + exclude_attachments: boolean; + repositories: Array< + MigrationsStartForAuthenticatedUserResponseDataRepositoriesItem + >; + url: string; + created_at: string; + updated_at: string; +}; + type MigrationsListForAuthenticatedUserEndpoint = { /** * Results per page (max 100) @@ -13172,49 +40312,342 @@ type MigrationsListForAuthenticatedUserEndpoint = { * Page number of the results to fetch. */ page?: number; -}; +} & RequiredPreview<"wyandotte">; + type MigrationsListForAuthenticatedUserRequestOptions = { method: "GET"; - url: Url; + url: "/user/migrations"; headers: RequestHeaders; request: RequestRequestOptions; }; +type MigrationsListForAuthenticatedUserResponseDataItemRepositoriesItemPermissions = { + admin: boolean; + push: boolean; + pull: boolean; +}; +type MigrationsListForAuthenticatedUserResponseDataItemRepositoriesItemOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type MigrationsListForAuthenticatedUserResponseDataItemRepositoriesItem = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: MigrationsListForAuthenticatedUserResponseDataItemRepositoriesItemOwner; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: null; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: Array; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: MigrationsListForAuthenticatedUserResponseDataItemRepositoriesItemPermissions; + allow_rebase_merge: boolean; + template_repository: null; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; +}; +type MigrationsListForAuthenticatedUserResponseDataItemOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type MigrationsListForAuthenticatedUserResponseDataItem = { + id: number; + owner: MigrationsListForAuthenticatedUserResponseDataItemOwner; + guid: string; + state: string; + lock_repositories: boolean; + exclude_attachments: boolean; + repositories: Array< + MigrationsListForAuthenticatedUserResponseDataItemRepositoriesItem + >; + url: string; + created_at: string; + updated_at: string; +}; +type MigrationsListForAuthenticatedUserResponseData = Array< + MigrationsListForAuthenticatedUserResponseDataItem +>; + type MigrationsGetStatusForAuthenticatedUserEndpoint = { /** * migration_id parameter */ migration_id: number; -}; +} & RequiredPreview<"wyandotte">; + type MigrationsGetStatusForAuthenticatedUserRequestOptions = { method: "GET"; - url: Url; + url: "/user/migrations/:migration_id"; headers: RequestHeaders; request: RequestRequestOptions; }; +type MigrationsGetStatusForAuthenticatedUserResponseDataRepositoriesItemPermissions = { + admin: boolean; + push: boolean; + pull: boolean; +}; +type MigrationsGetStatusForAuthenticatedUserResponseDataRepositoriesItemOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type MigrationsGetStatusForAuthenticatedUserResponseDataRepositoriesItem = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: MigrationsGetStatusForAuthenticatedUserResponseDataRepositoriesItemOwner; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: null; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: Array; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: MigrationsGetStatusForAuthenticatedUserResponseDataRepositoriesItemPermissions; + allow_rebase_merge: boolean; + template_repository: null; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; +}; +type MigrationsGetStatusForAuthenticatedUserResponseDataOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type MigrationsGetStatusForAuthenticatedUserResponseData = { + id: number; + owner: MigrationsGetStatusForAuthenticatedUserResponseDataOwner; + guid: string; + state: string; + lock_repositories: boolean; + exclude_attachments: boolean; + repositories: Array< + MigrationsGetStatusForAuthenticatedUserResponseDataRepositoriesItem + >; + url: string; + created_at: string; + updated_at: string; +}; + type MigrationsGetArchiveForAuthenticatedUserEndpoint = { /** * migration_id parameter */ migration_id: number; -}; +} & RequiredPreview<"wyandotte">; + type MigrationsGetArchiveForAuthenticatedUserRequestOptions = { method: "GET"; - url: Url; + url: "/user/migrations/:migration_id/archive"; headers: RequestHeaders; request: RequestRequestOptions; }; + type MigrationsDeleteArchiveForAuthenticatedUserEndpoint = { /** * migration_id parameter */ migration_id: number; -}; +} & RequiredPreview<"wyandotte">; + type MigrationsDeleteArchiveForAuthenticatedUserRequestOptions = { method: "DELETE"; - url: Url; + url: "/user/migrations/:migration_id/archive"; headers: RequestHeaders; request: RequestRequestOptions; }; + type MigrationsUnlockRepoForAuthenticatedUserEndpoint = { /** * migration_id parameter @@ -13224,13 +40657,15 @@ type MigrationsUnlockRepoForAuthenticatedUserEndpoint = { * repo_name parameter */ repo_name: string; -}; +} & RequiredPreview<"wyandotte">; + type MigrationsUnlockRepoForAuthenticatedUserRequestOptions = { method: "DELETE"; - url: Url; + url: "/user/migrations/:migration_id/repos/:repo_name/lock"; headers: RequestHeaders; request: RequestRequestOptions; }; + type OrgsListForAuthenticatedUserEndpoint = { /** * Results per page (max 100) @@ -13241,12 +40676,31 @@ type OrgsListForAuthenticatedUserEndpoint = { */ page?: number; }; + type OrgsListForAuthenticatedUserRequestOptions = { method: "GET"; - url: Url; + url: "/user/orgs"; headers: RequestHeaders; request: RequestRequestOptions; }; +type OrgsListForAuthenticatedUserResponseDataItem = { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; +}; +type OrgsListForAuthenticatedUserResponseData = Array< + OrgsListForAuthenticatedUserResponseDataItem +>; + type ProjectsCreateForAuthenticatedUserEndpoint = { /** * The name of the project. @@ -13256,13 +40710,50 @@ type ProjectsCreateForAuthenticatedUserEndpoint = { * The description of the project. */ body?: string; -}; +} & RequiredPreview<"inertia">; + type ProjectsCreateForAuthenticatedUserRequestOptions = { method: "POST"; - url: Url; + url: "/user/projects"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ProjectsCreateForAuthenticatedUserResponseDataCreator = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ProjectsCreateForAuthenticatedUserResponseData = { + owner_url: string; + url: string; + html_url: string; + columns_url: string; + id: number; + node_id: string; + name: string; + body: string; + number: number; + state: string; + creator: ProjectsCreateForAuthenticatedUserResponseDataCreator; + created_at: string; + updated_at: string; +}; + type UsersListPublicEmailsEndpoint = { /** * Results per page (max 100) @@ -13273,13 +40764,24 @@ type UsersListPublicEmailsEndpoint = { */ page?: number; }; + type UsersListPublicEmailsRequestOptions = { method: "GET"; - url: Url; + url: "/user/public_emails"; headers: RequestHeaders; request: RequestRequestOptions; }; -type ReposListEndpoint = { +type UsersListPublicEmailsResponseDataItem = { + email: string; + verified: boolean; + primary: boolean; + visibility: string; +}; +type UsersListPublicEmailsResponseData = Array< + UsersListPublicEmailsResponseDataItem +>; + +type ReposListForAuthenticatedUserEndpoint = { /** * Can be one of `all`, `public`, or `private`. */ @@ -13314,12 +40816,14 @@ type ReposListEndpoint = { */ page?: number; }; -type ReposListRequestOptions = { + +type ReposListForAuthenticatedUserRequestOptions = { method: "GET"; - url: Url; + url: "/user/repos"; headers: RequestHeaders; request: RequestRequestOptions; }; + type ReposCreateForAuthenticatedUserEndpoint = { /** * The name of the repository. @@ -13334,9 +40838,14 @@ type ReposCreateForAuthenticatedUserEndpoint = { */ homepage?: string; /** - * Either `true` to create a private repository or `false` to create a public one. Creating private repositories requires a paid GitHub account. + * Either `true` to create a private repository or `false` to create a public one. */ private?: boolean; + /** + * Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. For more information, see "[Creating an internal repository](https://help.github.com/github/creating-cloning-and-archiving-repositories/creating-an-internal-repository)" in the GitHub Help documentation. + * The `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header. + */ + visibility?: "public" | "private" | "visibility" | "internal"; /** * Either `true` to enable issues for this repository or `false` to disable them. */ @@ -13381,13 +40890,126 @@ type ReposCreateForAuthenticatedUserEndpoint = { * Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging. */ allow_rebase_merge?: boolean; + /** + * Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion. + */ + delete_branch_on_merge?: boolean; }; + type ReposCreateForAuthenticatedUserRequestOptions = { method: "POST"; - url: Url; + url: "/user/repos"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposCreateForAuthenticatedUserResponseDataPermissions = { + admin: boolean; + push: boolean; + pull: boolean; +}; +type ReposCreateForAuthenticatedUserResponseDataOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposCreateForAuthenticatedUserResponseData = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: ReposCreateForAuthenticatedUserResponseDataOwner; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: null; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: Array; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: ReposCreateForAuthenticatedUserResponseDataPermissions; + allow_rebase_merge: boolean; + template_repository: null; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; +}; + type ReposListInvitationsForAuthenticatedUserEndpoint = { /** * Results per page (max 100) @@ -13398,36 +41020,164 @@ type ReposListInvitationsForAuthenticatedUserEndpoint = { */ page?: number; }; + type ReposListInvitationsForAuthenticatedUserRequestOptions = { method: "GET"; - url: Url; + url: "/user/repository_invitations"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ReposListInvitationsForAuthenticatedUserResponseDataItemInviter = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposListInvitationsForAuthenticatedUserResponseDataItemInvitee = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposListInvitationsForAuthenticatedUserResponseDataItemRepositoryOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ReposListInvitationsForAuthenticatedUserResponseDataItemRepository = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: ReposListInvitationsForAuthenticatedUserResponseDataItemRepositoryOwner; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; +}; +type ReposListInvitationsForAuthenticatedUserResponseDataItem = { + id: number; + repository: ReposListInvitationsForAuthenticatedUserResponseDataItemRepository; + invitee: ReposListInvitationsForAuthenticatedUserResponseDataItemInvitee; + inviter: ReposListInvitationsForAuthenticatedUserResponseDataItemInviter; + permissions: string; + created_at: string; + url: string; + html_url: string; +}; +type ReposListInvitationsForAuthenticatedUserResponseData = Array< + ReposListInvitationsForAuthenticatedUserResponseDataItem +>; + type ReposAcceptInvitationEndpoint = { /** * invitation_id parameter */ invitation_id: number; }; + type ReposAcceptInvitationRequestOptions = { method: "PATCH"; - url: Url; + url: "/user/repository_invitations/:invitation_id"; headers: RequestHeaders; request: RequestRequestOptions; }; + type ReposDeclineInvitationEndpoint = { /** * invitation_id parameter */ invitation_id: number; }; + type ReposDeclineInvitationRequestOptions = { method: "DELETE"; - url: Url; + url: "/user/repository_invitations/:invitation_id"; headers: RequestHeaders; request: RequestRequestOptions; }; + type ActivityListReposStarredByAuthenticatedUserEndpoint = { /** * One of `created` (when the repository was starred) or `updated` (when it was last pushed to). @@ -13446,13 +41196,125 @@ type ActivityListReposStarredByAuthenticatedUserEndpoint = { */ page?: number; }; + type ActivityListReposStarredByAuthenticatedUserRequestOptions = { method: "GET"; - url: Url; + url: "/user/starred"; headers: RequestHeaders; request: RequestRequestOptions; }; -type ActivityCheckStarringRepoEndpoint = { +type ActivityListReposStarredByAuthenticatedUserResponseDataItemPermissions = { + admin: boolean; + push: boolean; + pull: boolean; +}; +type ActivityListReposStarredByAuthenticatedUserResponseDataItemOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ActivityListReposStarredByAuthenticatedUserResponseDataItem = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: ActivityListReposStarredByAuthenticatedUserResponseDataItemOwner; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: null; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: Array; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: ActivityListReposStarredByAuthenticatedUserResponseDataItemPermissions; + allow_rebase_merge: boolean; + template_repository: null; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; +}; +type ActivityListReposStarredByAuthenticatedUserResponseData = Array< + ActivityListReposStarredByAuthenticatedUserResponseDataItem +>; + +type ActivityCheckRepoIsStarredByAuthenticatedUserEndpoint = { /** * owner parameter */ @@ -13462,13 +41324,15 @@ type ActivityCheckStarringRepoEndpoint = { */ repo: string; }; -type ActivityCheckStarringRepoRequestOptions = { + +type ActivityCheckRepoIsStarredByAuthenticatedUserRequestOptions = { method: "GET"; - url: Url; + url: "/user/starred/:owner/:repo"; headers: RequestHeaders; request: RequestRequestOptions; }; -type ActivityStarRepoEndpoint = { + +type ActivityStarRepoForAuthenticatedUserEndpoint = { /** * owner parameter */ @@ -13478,13 +41342,15 @@ type ActivityStarRepoEndpoint = { */ repo: string; }; -type ActivityStarRepoRequestOptions = { + +type ActivityStarRepoForAuthenticatedUserRequestOptions = { method: "PUT"; - url: Url; + url: "/user/starred/:owner/:repo"; headers: RequestHeaders; request: RequestRequestOptions; }; -type ActivityUnstarRepoEndpoint = { + +type ActivityUnstarRepoForAuthenticatedUserEndpoint = { /** * owner parameter */ @@ -13494,12 +41360,14 @@ type ActivityUnstarRepoEndpoint = { */ repo: string; }; -type ActivityUnstarRepoRequestOptions = { + +type ActivityUnstarRepoForAuthenticatedUserRequestOptions = { method: "DELETE"; - url: Url; + url: "/user/starred/:owner/:repo"; headers: RequestHeaders; request: RequestRequestOptions; }; + type ActivityListWatchedReposForAuthenticatedUserEndpoint = { /** * Results per page (max 100) @@ -13510,12 +41378,129 @@ type ActivityListWatchedReposForAuthenticatedUserEndpoint = { */ page?: number; }; + type ActivityListWatchedReposForAuthenticatedUserRequestOptions = { method: "GET"; - url: Url; + url: "/user/subscriptions"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ActivityListWatchedReposForAuthenticatedUserResponseDataItemLicense = { + key: string; + name: string; + spdx_id: string; + url: string; + node_id: string; +}; +type ActivityListWatchedReposForAuthenticatedUserResponseDataItemPermissions = { + admin: boolean; + push: boolean; + pull: boolean; +}; +type ActivityListWatchedReposForAuthenticatedUserResponseDataItemOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ActivityListWatchedReposForAuthenticatedUserResponseDataItem = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: ActivityListWatchedReposForAuthenticatedUserResponseDataItemOwner; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: null; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: Array; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: ActivityListWatchedReposForAuthenticatedUserResponseDataItemPermissions; + template_repository: null; + temp_clone_token: string; + subscribers_count: number; + network_count: number; + license: ActivityListWatchedReposForAuthenticatedUserResponseDataItemLicense; +}; +type ActivityListWatchedReposForAuthenticatedUserResponseData = Array< + ActivityListWatchedReposForAuthenticatedUserResponseDataItem +>; + type ActivityCheckWatchingRepoLegacyEndpoint = { /** * owner parameter @@ -13526,12 +41511,14 @@ type ActivityCheckWatchingRepoLegacyEndpoint = { */ repo: string; }; + type ActivityCheckWatchingRepoLegacyRequestOptions = { method: "GET"; - url: Url; + url: "/user/subscriptions/:owner/:repo"; headers: RequestHeaders; request: RequestRequestOptions; }; + type ActivityWatchRepoLegacyEndpoint = { /** * owner parameter @@ -13542,12 +41529,14 @@ type ActivityWatchRepoLegacyEndpoint = { */ repo: string; }; + type ActivityWatchRepoLegacyRequestOptions = { method: "PUT"; - url: Url; + url: "/user/subscriptions/:owner/:repo"; headers: RequestHeaders; request: RequestRequestOptions; }; + type ActivityStopWatchingRepoLegacyEndpoint = { /** * owner parameter @@ -13558,12 +41547,14 @@ type ActivityStopWatchingRepoLegacyEndpoint = { */ repo: string; }; + type ActivityStopWatchingRepoLegacyRequestOptions = { method: "DELETE"; - url: Url; + url: "/user/subscriptions/:owner/:repo"; headers: RequestHeaders; request: RequestRequestOptions; }; + type TeamsListForAuthenticatedUserEndpoint = { /** * Results per page (max 100) @@ -13574,17 +41565,70 @@ type TeamsListForAuthenticatedUserEndpoint = { */ page?: number; }; + type TeamsListForAuthenticatedUserRequestOptions = { method: "GET"; - url: Url; + url: "/user/teams"; headers: RequestHeaders; request: RequestRequestOptions; }; -type UsersListEndpoint = { +type TeamsListForAuthenticatedUserResponseDataItemOrganization = { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; + name: string; + company: string; + blog: string; + location: string; + email: string; + is_verified: boolean; + has_organization_projects: boolean; + has_repository_projects: boolean; + public_repos: number; + public_gists: number; + followers: number; + following: number; + html_url: string; + created_at: string; + type: string; +}; +type TeamsListForAuthenticatedUserResponseDataItem = { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: null; + members_count: number; + repos_count: number; + created_at: string; + updated_at: string; + organization: TeamsListForAuthenticatedUserResponseDataItemOrganization; +}; +type TeamsListForAuthenticatedUserResponseData = Array< + TeamsListForAuthenticatedUserResponseDataItem +>; + +type MigrationsListReposForUserEndpoint = { /** - * The integer ID of the last User that you've seen. + * migration_id parameter */ - since?: string; + migration_id: number; /** * Results per page (max 100) */ @@ -13593,26 +41637,220 @@ type UsersListEndpoint = { * Page number of the results to fetch. */ page?: number; -}; -type UsersListRequestOptions = { +} & RequiredPreview<"wyandotte">; + +type MigrationsListReposForUserRequestOptions = { method: "GET"; - url: Url; + url: "/user/:migration_id/repositories"; headers: RequestHeaders; request: RequestRequestOptions; }; +type MigrationsListReposForUserResponseDataItemLicense = { + key: string; + name: string; + spdx_id: string; + url: string; + node_id: string; +}; +type MigrationsListReposForUserResponseDataItemPermissions = { + admin: boolean; + push: boolean; + pull: boolean; +}; +type MigrationsListReposForUserResponseDataItemOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type MigrationsListReposForUserResponseDataItem = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: MigrationsListReposForUserResponseDataItemOwner; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: null; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: Array; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: MigrationsListReposForUserResponseDataItemPermissions; + template_repository: null; + temp_clone_token: string; + subscribers_count: number; + network_count: number; + license: MigrationsListReposForUserResponseDataItemLicense; +}; +type MigrationsListReposForUserResponseData = Array< + MigrationsListReposForUserResponseDataItem +>; + +type UsersListEndpoint = { + /** + * The integer ID of the last User that you've seen. + */ + since?: string; +}; + +type UsersListRequestOptions = { + method: "GET"; + url: "/users"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersListResponseDataItem = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type UsersListResponseData = Array; + type UsersGetByUsernameEndpoint = { /** * username parameter */ username: string; }; + type UsersGetByUsernameRequestOptions = { method: "GET"; - url: Url; + url: "/users/:username"; headers: RequestHeaders; request: RequestRequestOptions; }; -type ActivityListEventsForUserEndpoint = { +type UsersGetByUsernameResponseDataPlan = { + name: string; + space: number; + collaborators: number; + private_repos: number; +}; +type UsersGetByUsernameResponseData = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + name: string; + company: string; + blog: string; + location: string; + email: string; + hireable: boolean; + bio: string; + public_repos: number; + public_gists: number; + followers: number; + following: number; + created_at: string; + updated_at: string; + plan?: UsersGetByUsernameResponseDataPlan; +}; + +type ActivityListEventsForAuthenticatedUserEndpoint = { /** * username parameter */ @@ -13626,13 +41864,15 @@ type ActivityListEventsForUserEndpoint = { */ page?: number; }; -type ActivityListEventsForUserRequestOptions = { + +type ActivityListEventsForAuthenticatedUserRequestOptions = { method: "GET"; - url: Url; + url: "/users/:username/events"; headers: RequestHeaders; request: RequestRequestOptions; }; -type ActivityListEventsForOrgEndpoint = { + +type ActivityListOrgEventsForAuthenticatedUserEndpoint = { /** * username parameter */ @@ -13650,12 +41890,14 @@ type ActivityListEventsForOrgEndpoint = { */ page?: number; }; -type ActivityListEventsForOrgRequestOptions = { + +type ActivityListOrgEventsForAuthenticatedUserRequestOptions = { method: "GET"; - url: Url; + url: "/users/:username/events/orgs/:org"; headers: RequestHeaders; request: RequestRequestOptions; }; + type ActivityListPublicEventsForUserEndpoint = { /** * username parameter @@ -13670,12 +41912,14 @@ type ActivityListPublicEventsForUserEndpoint = { */ page?: number; }; + type ActivityListPublicEventsForUserRequestOptions = { method: "GET"; - url: Url; + url: "/users/:username/events/public"; headers: RequestHeaders; request: RequestRequestOptions; }; + type UsersListFollowersForUserEndpoint = { /** * username parameter @@ -13690,12 +41934,37 @@ type UsersListFollowersForUserEndpoint = { */ page?: number; }; + type UsersListFollowersForUserRequestOptions = { method: "GET"; - url: Url; + url: "/users/:username/followers"; headers: RequestHeaders; request: RequestRequestOptions; }; +type UsersListFollowersForUserResponseDataItem = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type UsersListFollowersForUserResponseData = Array< + UsersListFollowersForUserResponseDataItem +>; + type UsersListFollowingForUserEndpoint = { /** * username parameter @@ -13710,12 +41979,37 @@ type UsersListFollowingForUserEndpoint = { */ page?: number; }; + type UsersListFollowingForUserRequestOptions = { method: "GET"; - url: Url; + url: "/users/:username/following"; headers: RequestHeaders; request: RequestRequestOptions; }; +type UsersListFollowingForUserResponseDataItem = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type UsersListFollowingForUserResponseData = Array< + UsersListFollowingForUserResponseDataItem +>; + type UsersCheckFollowingForUserEndpoint = { /** * username parameter @@ -13726,13 +42020,15 @@ type UsersCheckFollowingForUserEndpoint = { */ target_user: string; }; + type UsersCheckFollowingForUserRequestOptions = { method: "GET"; - url: Url; + url: "/users/:username/following/:target_user"; headers: RequestHeaders; request: RequestRequestOptions; }; -type GistsListPublicForUserEndpoint = { + +type GistsListForUserEndpoint = { /** * username parameter */ @@ -13750,12 +42046,65 @@ type GistsListPublicForUserEndpoint = { */ page?: number; }; -type GistsListPublicForUserRequestOptions = { + +type GistsListForUserRequestOptions = { method: "GET"; - url: Url; + url: "/users/:username/gists"; headers: RequestHeaders; request: RequestRequestOptions; }; +type GistsListForUserResponseDataItemOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type GistsListForUserResponseDataItemFilesHelloWorldRb = { + filename: string; + type: string; + language: string; + raw_url: string; + size: number; +}; +type GistsListForUserResponseDataItemFiles = { + "hello_world.rb": GistsListForUserResponseDataItemFilesHelloWorldRb; +}; +type GistsListForUserResponseDataItem = { + url: string; + forks_url: string; + commits_url: string; + id: string; + node_id: string; + git_pull_url: string; + git_push_url: string; + html_url: string; + files: GistsListForUserResponseDataItemFiles; + public: boolean; + created_at: string; + updated_at: string; + description: string; + comments: number; + user: null; + comments_url: string; + owner: GistsListForUserResponseDataItemOwner; + truncated: boolean; +}; +type GistsListForUserResponseData = Array; + type UsersListGpgKeysForUserEndpoint = { /** * username parameter @@ -13770,12 +42119,49 @@ type UsersListGpgKeysForUserEndpoint = { */ page?: number; }; + type UsersListGpgKeysForUserRequestOptions = { method: "GET"; - url: Url; + url: "/users/:username/gpg_keys"; headers: RequestHeaders; request: RequestRequestOptions; }; +type UsersListGpgKeysForUserResponseDataItemSubkeysItem = { + id: number; + primary_key_id: number; + key_id: string; + public_key: string; + emails: Array; + subkeys: Array; + can_sign: boolean; + can_encrypt_comms: boolean; + can_encrypt_storage: boolean; + can_certify: boolean; + created_at: string; + expires_at: null; +}; +type UsersListGpgKeysForUserResponseDataItemEmailsItem = { + email: string; + verified: boolean; +}; +type UsersListGpgKeysForUserResponseDataItem = { + id: number; + primary_key_id: null; + key_id: string; + public_key: string; + emails: Array; + subkeys: Array; + can_sign: boolean; + can_encrypt_comms: boolean; + can_encrypt_storage: boolean; + can_certify: boolean; + created_at: string; + expires_at: null; +}; +type UsersListGpgKeysForUserResponseData = Array< + UsersListGpgKeysForUserResponseDataItem +>; + type UsersGetContextForUserEndpoint = { /** * username parameter @@ -13790,36 +42176,76 @@ type UsersGetContextForUserEndpoint = { */ subject_id?: string; }; + type UsersGetContextForUserRequestOptions = { method: "GET"; - url: Url; + url: "/users/:username/hovercard"; headers: RequestHeaders; request: RequestRequestOptions; }; +type UsersGetContextForUserResponseDataContextsItem = { + message: string; + octicon: string; +}; +type UsersGetContextForUserResponseData = { + contexts: Array; +}; + type AppsGetUserInstallationEndpoint = { /** * username parameter */ username: string; -}; +} & RequiredPreview<"machine-man">; + type AppsGetUserInstallationRequestOptions = { method: "GET"; - url: Url; + url: "/users/:username/installation"; headers: RequestHeaders; request: RequestRequestOptions; }; -type AppsFindUserInstallationEndpoint = { - /** - * username parameter - */ - username: string; +type AppsGetUserInstallationResponseDataPermissions = { + checks: string; + metadata: string; + contents: string; }; -type AppsFindUserInstallationRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; +type AppsGetUserInstallationResponseDataAccount = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; }; +type AppsGetUserInstallationResponseData = { + id: number; + account: AppsGetUserInstallationResponseDataAccount; + repository_selection: string; + access_tokens_url: string; + repositories_url: string; + html_url: string; + app_id: number; + target_id: number; + target_type: string; + permissions: AppsGetUserInstallationResponseDataPermissions; + events: Array; + created_at: string; + updated_at: string; + single_file_name: null; +}; + type UsersListPublicKeysForUserEndpoint = { /** * username parameter @@ -13834,12 +42260,18 @@ type UsersListPublicKeysForUserEndpoint = { */ page?: number; }; + type UsersListPublicKeysForUserRequestOptions = { method: "GET"; - url: Url; + url: "/users/:username/keys"; headers: RequestHeaders; request: RequestRequestOptions; }; +type UsersListPublicKeysForUserResponseDataItem = { id: number; key: string }; +type UsersListPublicKeysForUserResponseData = Array< + UsersListPublicKeysForUserResponseDataItem +>; + type OrgsListForUserEndpoint = { /** * username parameter @@ -13854,12 +42286,29 @@ type OrgsListForUserEndpoint = { */ page?: number; }; + type OrgsListForUserRequestOptions = { method: "GET"; - url: Url; + url: "/users/:username/orgs"; headers: RequestHeaders; request: RequestRequestOptions; }; +type OrgsListForUserResponseDataItem = { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; +}; +type OrgsListForUserResponseData = Array; + type ProjectsListForUserEndpoint = { /** * username parameter @@ -13877,13 +42326,53 @@ type ProjectsListForUserEndpoint = { * Page number of the results to fetch. */ page?: number; -}; +} & RequiredPreview<"inertia">; + type ProjectsListForUserRequestOptions = { method: "GET"; - url: Url; + url: "/users/:username/projects"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ProjectsListForUserResponseDataItemCreator = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ProjectsListForUserResponseDataItem = { + owner_url: string; + url: string; + html_url: string; + columns_url: string; + id: number; + node_id: string; + name: string; + body: string; + number: number; + state: string; + creator: ProjectsListForUserResponseDataItemCreator; + created_at: string; + updated_at: string; +}; +type ProjectsListForUserResponseData = Array< + ProjectsListForUserResponseDataItem +>; + type ActivityListReceivedEventsForUserEndpoint = { /** * username parameter @@ -13898,12 +42387,14 @@ type ActivityListReceivedEventsForUserEndpoint = { */ page?: number; }; + type ActivityListReceivedEventsForUserRequestOptions = { method: "GET"; - url: Url; + url: "/users/:username/received_events"; headers: RequestHeaders; request: RequestRequestOptions; }; + type ActivityListReceivedPublicEventsForUserEndpoint = { /** * username parameter @@ -13918,12 +42409,14 @@ type ActivityListReceivedPublicEventsForUserEndpoint = { */ page?: number; }; + type ActivityListReceivedPublicEventsForUserRequestOptions = { method: "GET"; - url: Url; + url: "/users/:username/received_events/public"; headers: RequestHeaders; request: RequestRequestOptions; }; + type ReposListForUserEndpoint = { /** * username parameter @@ -13950,12 +42443,14 @@ type ReposListForUserEndpoint = { */ page?: number; }; + type ReposListForUserRequestOptions = { method: "GET"; - url: Url; + url: "/users/:username/repos"; headers: RequestHeaders; request: RequestRequestOptions; }; + type ActivityListReposStarredByUserEndpoint = { /** * username parameter @@ -13978,12 +42473,124 @@ type ActivityListReposStarredByUserEndpoint = { */ page?: number; }; + type ActivityListReposStarredByUserRequestOptions = { method: "GET"; - url: Url; + url: "/users/:username/starred"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ActivityListReposStarredByUserResponseDataItemPermissions = { + admin: boolean; + push: boolean; + pull: boolean; +}; +type ActivityListReposStarredByUserResponseDataItemOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ActivityListReposStarredByUserResponseDataItem = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: ActivityListReposStarredByUserResponseDataItemOwner; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: null; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: Array; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: ActivityListReposStarredByUserResponseDataItemPermissions; + allow_rebase_merge: boolean; + template_repository: null; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; +}; +type ActivityListReposStarredByUserResponseData = Array< + ActivityListReposStarredByUserResponseDataItem +>; + type ActivityListReposWatchedByUserEndpoint = { /** * username parameter @@ -13998,64 +42605,185 @@ type ActivityListReposWatchedByUserEndpoint = { */ page?: number; }; + type ActivityListReposWatchedByUserRequestOptions = { method: "GET"; - url: Url; + url: "/users/:username/subscriptions"; headers: RequestHeaders; request: RequestRequestOptions; }; +type ActivityListReposWatchedByUserResponseDataItemLicense = { + key: string; + name: string; + spdx_id: string; + url: string; + node_id: string; +}; +type ActivityListReposWatchedByUserResponseDataItemPermissions = { + admin: boolean; + push: boolean; + pull: boolean; +}; +type ActivityListReposWatchedByUserResponseDataItemOwner = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}; +type ActivityListReposWatchedByUserResponseDataItem = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: ActivityListReposWatchedByUserResponseDataItemOwner; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: null; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: Array; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: ActivityListReposWatchedByUserResponseDataItemPermissions; + template_repository: null; + temp_clone_token: string; + subscribers_count: number; + network_count: number; + license: ActivityListReposWatchedByUserResponseDataItemLicense; +}; +type ActivityListReposWatchedByUserResponseData = Array< + ActivityListReposWatchedByUserResponseDataItem +>; -export type AppsCreateInstallationTokenParamsPermissions = {}; -export type GistsCreateParamsFiles = { +type AppsCreateInstallationTokenParamsPermissions = {}; +type GistsCreateParamsFiles = { content?: string; }; -export type GistsUpdateParamsFiles = { +type GistsUpdateParamsFiles = { content?: string; filename?: string; }; -export type OrgsCreateHookParamsConfig = { +type OrgsCreateHookParamsConfig = { url: string; content_type?: string; secret?: string; insecure_ssl?: string; }; -export type OrgsUpdateHookParamsConfig = { +type OrgsUpdateHookParamsConfig = { url: string; content_type?: string; secret?: string; insecure_ssl?: string; }; -export type ReposUpdateBranchProtectionParamsRequiredStatusChecks = { +type TeamsCreateOrUpdateIdPGroupConnectionsInOrgParamsGroups = { + group_id: string; + group_name: string; + group_description: string; +}; +type ReposUpdateBranchProtectionParamsRequiredStatusChecks = { strict: boolean; contexts: string[]; }; -export type ReposUpdateBranchProtectionParamsRequiredPullRequestReviews = { +type ReposUpdateBranchProtectionParamsRequiredPullRequestReviews = { dismissal_restrictions?: ReposUpdateBranchProtectionParamsRequiredPullRequestReviewsDismissalRestrictions; dismiss_stale_reviews?: boolean; require_code_owner_reviews?: boolean; required_approving_review_count?: number; }; -export type ReposUpdateBranchProtectionParamsRequiredPullRequestReviewsDismissalRestrictions = { +type ReposUpdateBranchProtectionParamsRequiredPullRequestReviewsDismissalRestrictions = { users?: string[]; teams?: string[]; }; -export type ReposUpdateBranchProtectionParamsRestrictions = { +type ReposUpdateBranchProtectionParamsRestrictions = { users: string[]; teams: string[]; apps?: string[]; }; -export type ReposUpdateProtectedBranchPullRequestReviewEnforcementParamsDismissalRestrictions = { +type ReposUpdateProtectedBranchPullRequestReviewEnforcementParamsDismissalRestrictions = { users?: string[]; teams?: string[]; }; -export type ChecksCreateParamsOutput = { +type ChecksCreateParamsOutput = { title: string; summary: string; text?: string; annotations?: ChecksCreateParamsOutputAnnotations[]; images?: ChecksCreateParamsOutputImages[]; }; -export type ChecksCreateParamsOutputAnnotations = { +type ChecksCreateParamsOutputAnnotations = { path: string; start_line: number; end_line: number; @@ -14066,24 +42794,24 @@ export type ChecksCreateParamsOutputAnnotations = { title?: string; raw_details?: string; }; -export type ChecksCreateParamsOutputImages = { +type ChecksCreateParamsOutputImages = { alt: string; image_url: string; caption?: string; }; -export type ChecksCreateParamsActions = { +type ChecksCreateParamsActions = { label: string; description: string; identifier: string; }; -export type ChecksUpdateParamsOutput = { +type ChecksUpdateParamsOutput = { title?: string; summary: string; text?: string; annotations?: ChecksUpdateParamsOutputAnnotations[]; images?: ChecksUpdateParamsOutputImages[]; }; -export type ChecksUpdateParamsOutputAnnotations = { +type ChecksUpdateParamsOutputAnnotations = { path: string; start_line: number; end_line: number; @@ -14094,96 +42822,81 @@ export type ChecksUpdateParamsOutputAnnotations = { title?: string; raw_details?: string; }; -export type ChecksUpdateParamsOutputImages = { +type ChecksUpdateParamsOutputImages = { alt: string; image_url: string; caption?: string; }; -export type ChecksUpdateParamsActions = { +type ChecksUpdateParamsActions = { label: string; description: string; identifier: string; }; -export type ChecksSetSuitesPreferencesParamsAutoTriggerChecks = { +type ChecksSetSuitesPreferencesParamsAutoTriggerChecks = { app_id: number; setting: boolean; }; -export type ReposCreateOrUpdateFileParamsCommitter = { +type ReposCreateOrUpdateFileParamsCommitter = { name: string; email: string; }; -export type ReposCreateOrUpdateFileParamsAuthor = { +type ReposCreateOrUpdateFileParamsAuthor = { name: string; email: string; }; -export type ReposCreateFileParamsCommitter = { - name: string; - email: string; -}; -export type ReposCreateFileParamsAuthor = { - name: string; - email: string; -}; -export type ReposUpdateFileParamsCommitter = { - name: string; - email: string; -}; -export type ReposUpdateFileParamsAuthor = { - name: string; - email: string; -}; -export type ReposDeleteFileParamsCommitter = { +type ReposDeleteFileParamsCommitter = { name?: string; email?: string; }; -export type ReposDeleteFileParamsAuthor = { +type ReposDeleteFileParamsAuthor = { name?: string; email?: string; }; -export type GitCreateCommitParamsAuthor = { +type ReposCreateDispatchEventParamsClientPayload = {}; +type GitCreateCommitParamsAuthor = { name?: string; email?: string; date?: string; }; -export type GitCreateCommitParamsCommitter = { +type GitCreateCommitParamsCommitter = { name?: string; email?: string; date?: string; }; -export type GitCreateTagParamsTagger = { +type GitCreateTagParamsTagger = { name?: string; email?: string; date?: string; }; -export type GitCreateTreeParamsTree = { +type GitCreateTreeParamsTree = { path?: string; mode?: "100644" | "100755" | "040000" | "160000" | "120000"; type?: "blob" | "tree" | "commit"; - sha?: string; + sha?: string | null; content?: string; }; -export type ReposCreateHookParamsConfig = { +type ReposCreateHookParamsConfig = { url: string; content_type?: string; secret?: string; insecure_ssl?: string; }; -export type ReposUpdateHookParamsConfig = { +type ReposUpdateHookParamsConfig = { url: string; content_type?: string; secret?: string; insecure_ssl?: string; }; -export type ReposEnablePagesSiteParamsSource = { +type ReposEnablePagesSiteParamsSource = { branch?: "master" | "gh-pages"; path?: string; }; -export type PullsCreateReviewParamsComments = { +type PullsCreateReviewParamsComments = { path: string; position: number; body: string; }; -export type TeamsCreateOrUpdateIdPGroupConnectionsParamsGroups = { +type TeamsCreateOrUpdateIdPGroupConnectionsLegacyParamsGroups = { group_id: string; group_name: string; group_description: string; diff --git a/node_modules/@octokit/types/src/index.ts b/node_modules/@octokit/types/src/index.ts index 200f0a2..5d2d5ae 100644 --- a/node_modules/@octokit/types/src/index.ts +++ b/node_modules/@octokit/types/src/index.ts @@ -16,3 +16,5 @@ export * from "./Signal"; export * from "./StrategyInterface"; export * from "./Url"; export * from "./VERSION"; +export * from "./GetResponseTypeFromEndpointMethod"; +export * from "./generated/Endpoints"; diff --git a/node_modules/@types/node/LICENSE b/node_modules/@types/node/LICENSE index 4b1ad51..9e841e7 100644 --- a/node_modules/@types/node/LICENSE +++ b/node_modules/@types/node/LICENSE @@ -1,21 +1,21 @@ - MIT License - - Copyright (c) Microsoft Corporation. All rights reserved. - - 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 + MIT License + + Copyright (c) Microsoft Corporation. + + 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 diff --git a/node_modules/@types/node/README.md b/node_modules/@types/node/README.md index d842f1f..bb7af03 100644 --- a/node_modules/@types/node/README.md +++ b/node_modules/@types/node/README.md @@ -8,9 +8,9 @@ This package contains type definitions for Node.js (http://nodejs.org/). Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node. ### Additional Details - * Last updated: Tue, 19 Nov 2019 19:44:54 GMT + * Last updated: Wed, 28 Oct 2020 18:55:35 GMT * Dependencies: none - * Global values: `Buffer`, `NodeJS`, `Symbol`, `__dirname`, `__filename`, `clearImmediate`, `clearInterval`, `clearTimeout`, `console`, `exports`, `global`, `module`, `process`, `queueMicrotask`, `require`, `setImmediate`, `setInterval`, `setTimeout` + * Global values: `Buffer`, `__dirname`, `__filename`, `clearImmediate`, `clearInterval`, `clearTimeout`, `console`, `exports`, `global`, `module`, `process`, `queueMicrotask`, `require`, `setImmediate`, `setInterval`, `setTimeout` # Credits -These definitions were written by Microsoft TypeScript (https://github.com/Microsoft), DefinitelyTyped (https://github.com/DefinitelyTyped), Alberto Schiabel (https://github.com/jkomyno), Alexander T. (https://github.com/a-tarasyuk), Alvis HT Tang (https://github.com/alvis), Andrew Makarov (https://github.com/r3nya), Benjamin Toueg (https://github.com/btoueg), Bruno Scheufler (https://github.com/brunoscheufler), Chigozirim C. (https://github.com/smac89), Christian Vaagland Tellnes (https://github.com/tellnes), David Junger (https://github.com/touffy), Deividas Bakanas (https://github.com/DeividasBakanas), Eugene Y. Q. Shen (https://github.com/eyqs), Flarna (https://github.com/Flarna), Hannes Magnusson (https://github.com/Hannes-Magnusson-CK), Hoàng Văn Khải (https://github.com/KSXGitHub), Huw (https://github.com/hoo29), Kelvin Jin (https://github.com/kjin), Klaus Meinhardt (https://github.com/ajafff), Lishude (https://github.com/islishude), Mariusz Wiktorczyk (https://github.com/mwiktorczyk), Mohsen Azimi (https://github.com/mohsen1), Nicolas Even (https://github.com/n-e), Nicolas Voigt (https://github.com/octo-sniffle), Nikita Galkin (https://github.com/galkin), Parambir Singh (https://github.com/parambirs), Sebastian Silbermann (https://github.com/eps1lon), Simon Schick (https://github.com/SimonSchick), Thomas den Hollander (https://github.com/ThomasdenH), Wilco Bakker (https://github.com/WilcoBakker), wwwy3y3 (https://github.com/wwwy3y3), Zane Hannan AU (https://github.com/ZaneHannanAU), Samuel Ainsworth (https://github.com/samuela), Kyle Uehlein (https://github.com/kuehlein), Jordi Oliveras Rovira (https://github.com/j-oliveras), Thanik Bhongbhibhat (https://github.com/bhongy), Marcin Kopacz (https://github.com/chyzwar), Trivikram Kamat (https://github.com/trivikr), Minh Son Nguyen (https://github.com/nguymin4), and Junxiao Shi (https://github.com/yoursunny). +These definitions were written by [Microsoft TypeScript](https://github.com/Microsoft), [DefinitelyTyped](https://github.com/DefinitelyTyped), [Alberto Schiabel](https://github.com/jkomyno), [Alexander T.](https://github.com/a-tarasyuk), [Alvis HT Tang](https://github.com/alvis), [Andrew Makarov](https://github.com/r3nya), [Benjamin Toueg](https://github.com/btoueg), [Bruno Scheufler](https://github.com/brunoscheufler), [Chigozirim C.](https://github.com/smac89), [David Junger](https://github.com/touffy), [Deividas Bakanas](https://github.com/DeividasBakanas), [Eugene Y. Q. Shen](https://github.com/eyqs), [Flarna](https://github.com/Flarna), [Hannes Magnusson](https://github.com/Hannes-Magnusson-CK), [Hoàng Văn Khải](https://github.com/KSXGitHub), [Huw](https://github.com/hoo29), [Kelvin Jin](https://github.com/kjin), [Klaus Meinhardt](https://github.com/ajafff), [Lishude](https://github.com/islishude), [Mariusz Wiktorczyk](https://github.com/mwiktorczyk), [Mohsen Azimi](https://github.com/mohsen1), [Nicolas Even](https://github.com/n-e), [Nikita Galkin](https://github.com/galkin), [Parambir Singh](https://github.com/parambirs), [Sebastian Silbermann](https://github.com/eps1lon), [Simon Schick](https://github.com/SimonSchick), [Thomas den Hollander](https://github.com/ThomasdenH), [Wilco Bakker](https://github.com/WilcoBakker), [wwwy3y3](https://github.com/wwwy3y3), [Samuel Ainsworth](https://github.com/samuela), [Kyle Uehlein](https://github.com/kuehlein), [Jordi Oliveras Rovira](https://github.com/j-oliveras), [Thanik Bhongbhibhat](https://github.com/bhongy), [Marcin Kopacz](https://github.com/chyzwar), [Trivikram Kamat](https://github.com/trivikr), [Minh Son Nguyen](https://github.com/nguymin4), [Junxiao Shi](https://github.com/yoursunny), [Ilia Baryshnikov](https://github.com/qwelias), [ExE Boss](https://github.com/ExE-Boss), [Surasak Chaisurin](https://github.com/Ryan-Willpower), [Piotr Błażejewicz](https://github.com/peterblazejewicz), [Anna Henningsen](https://github.com/addaleax), [Jason Kwok](https://github.com/JasonHK), and [Victor Perin](https://github.com/victorperin). diff --git a/node_modules/@types/node/assert.d.ts b/node_modules/@types/node/assert.d.ts index 1244813..3706d99 100644 --- a/node_modules/@types/node/assert.d.ts +++ b/node_modules/@types/node/assert.d.ts @@ -1,6 +1,7 @@ -declare module "assert" { - function internal(value: any, message?: string | Error): void; - namespace internal { +declare module 'assert' { + /** An alias of `assert.ok()`. */ + function assert(value: any, message?: string | Error): asserts value; + namespace assert { class AssertionError implements Error { name: string; message: string; @@ -11,38 +12,109 @@ declare module "assert" { code: 'ERR_ASSERTION'; constructor(options?: { - message?: string; actual?: any; expected?: any; - operator?: string; stackStartFn?: Function + /** If provided, the error message is set to this value. */ + message?: string; + /** The `actual` property on the error instance. */ + actual?: any; + /** The `expected` property on the error instance. */ + expected?: any; + /** The `operator` property on the error instance. */ + operator?: string; + /** If provided, the generated stack trace omits frames before this function. */ + stackStartFn?: Function; }); } + class CallTracker { + calls(exact?: number): () => void; + calls any>(fn?: Func, exact?: number): Func; + report(): CallTrackerReportInformation[]; + verify(): void; + } + export interface CallTrackerReportInformation { + message: string; + /** The actual number of times the function was called. */ + actual: number; + /** The number of times the function was expected to be called. */ + expected: number; + /** The name of the function that is wrapped. */ + operator: string; + /** A stack trace of the function. */ + stack: object; + } + + type AssertPredicate = RegExp | (new () => object) | ((thrown: any) => boolean) | object | Error; + function fail(message?: string | Error): never; /** @deprecated since v10.0.0 - use fail([message]) or other assert functions instead. */ - function fail(actual: any, expected: any, message?: string | Error, operator?: string, stackStartFn?: Function): never; - function ok(value: any, message?: string | Error): void; + function fail( + actual: any, + expected: any, + message?: string | Error, + operator?: string, + stackStartFn?: Function, + ): never; + function ok(value: any, message?: string | Error): asserts value; + /** @deprecated since v9.9.0 - use strictEqual() instead. */ function equal(actual: any, expected: any, message?: string | Error): void; + /** @deprecated since v9.9.0 - use notStrictEqual() instead. */ function notEqual(actual: any, expected: any, message?: string | Error): void; + /** @deprecated since v9.9.0 - use deepStrictEqual() instead. */ function deepEqual(actual: any, expected: any, message?: string | Error): void; + /** @deprecated since v9.9.0 - use notDeepStrictEqual() instead. */ function notDeepEqual(actual: any, expected: any, message?: string | Error): void; - function strictEqual(actual: any, expected: any, message?: string | Error): void; + function strictEqual(actual: any, expected: T, message?: string | Error): asserts actual is T; function notStrictEqual(actual: any, expected: any, message?: string | Error): void; - function deepStrictEqual(actual: any, expected: any, message?: string | Error): void; + function deepStrictEqual(actual: any, expected: T, message?: string | Error): asserts actual is T; function notDeepStrictEqual(actual: any, expected: any, message?: string | Error): void; function throws(block: () => any, message?: string | Error): void; - function throws(block: () => any, error: RegExp | Function | Object | Error, message?: string | Error): void; + function throws(block: () => any, error: AssertPredicate, message?: string | Error): void; function doesNotThrow(block: () => any, message?: string | Error): void; function doesNotThrow(block: () => any, error: RegExp | Function, message?: string | Error): void; - function ifError(value: any): void; + function ifError(value: any): asserts value is null | undefined; function rejects(block: (() => Promise) | Promise, message?: string | Error): Promise; - function rejects(block: (() => Promise) | Promise, error: RegExp | Function | Object | Error, message?: string | Error): Promise; + function rejects( + block: (() => Promise) | Promise, + error: AssertPredicate, + message?: string | Error, + ): Promise; function doesNotReject(block: (() => Promise) | Promise, message?: string | Error): Promise; - function doesNotReject(block: (() => Promise) | Promise, error: RegExp | Function, message?: string | Error): Promise; + function doesNotReject( + block: (() => Promise) | Promise, + error: RegExp | Function, + message?: string | Error, + ): Promise; - const strict: typeof internal; + function match(value: string, regExp: RegExp, message?: string | Error): void; + function doesNotMatch(value: string, regExp: RegExp, message?: string | Error): void; + + const strict: Omit< + typeof assert, + | 'strict' + | 'deepEqual' + | 'notDeepEqual' + | 'equal' + | 'notEqual' + | 'ok' + | 'strictEqual' + | 'deepStrictEqual' + | 'ifError' + > & { + (value: any, message?: string | Error): asserts value; + strict: typeof strict; + deepEqual: typeof deepStrictEqual; + notDeepEqual: typeof notDeepStrictEqual; + equal: typeof strictEqual; + notEqual: typeof notStrictEqual; + ok(value: any, message?: string | Error): asserts value; + strictEqual(actual: any, expected: T, message?: string | Error): asserts actual is T; + deepStrictEqual(actual: any, expected: T, message?: string | Error): asserts actual is T; + ifError(value: any): asserts value is null | undefined; + }; } - export = internal; + export = assert; } diff --git a/node_modules/@types/node/async_hooks.d.ts b/node_modules/@types/node/async_hooks.d.ts index cca992e..ab35e5d 100644 --- a/node_modules/@types/node/async_hooks.d.ts +++ b/node_modules/@types/node/async_hooks.d.ts @@ -7,6 +7,20 @@ declare module "async_hooks" { */ function executionAsyncId(): number; + /** + * The resource representing the current execution. + * Useful to store data within the resource. + * + * Resource objects returned by `executionAsyncResource()` are most often internal + * Node.js handle objects with undocumented APIs. Using any functions or properties + * on the object is likely to crash your application and should be avoided. + * + * Using `executionAsyncResource()` in the top-level execution context will + * return an empty object as there is no handle or request object to use, + * but having an object representing the top-level can be helpful. + */ + function executionAsyncResource(): object; + /** * Returns the ID of the resource responsible for calling the callback that is currently being executed. */ @@ -20,7 +34,7 @@ declare module "async_hooks" { * @param triggerAsyncId the unique ID of the async resource in whose execution context this async resource was created * @param resource reference to the resource representing the async operation, needs to be released during destroy */ - init?(asyncId: number, type: string, triggerAsyncId: number, resource: Object): void; + init?(asyncId: number, type: string, triggerAsyncId: number, resource: object): void; /** * When an asynchronous operation is initiated or completes a callback is called to notify the user. @@ -101,6 +115,19 @@ declare module "async_hooks" { */ constructor(type: string, triggerAsyncId?: number|AsyncResourceOptions); + /** + * Binds the given function to the current execution context. + * @param fn The function to bind to the current execution context. + * @param type An optional name to associate with the underlying `AsyncResource`. + */ + static bind any>(fn: Func, type?: string): Func & { asyncResource: AsyncResource }; + + /** + * Binds the given function to execute to this `AsyncResource`'s scope. + * @param fn The function to bind to the current `AsyncResource`. + */ + bind any>(fn: Func): Func & { asyncResource: AsyncResource }; + /** * Call the provided function with the provided arguments in the * execution context of the async resource. This will establish the @@ -129,4 +156,71 @@ declare module "async_hooks" { */ triggerAsyncId(): number; } + + /** + * When having multiple instances of `AsyncLocalStorage`, they are independent + * from each other. It is safe to instantiate this class multiple times. + */ + class AsyncLocalStorage { + /** + * This method disables the instance of `AsyncLocalStorage`. All subsequent calls + * to `asyncLocalStorage.getStore()` will return `undefined` until + * `asyncLocalStorage.run()` is called again. + * + * When calling `asyncLocalStorage.disable()`, all current contexts linked to the + * instance will be exited. + * + * Calling `asyncLocalStorage.disable()` is required before the + * `asyncLocalStorage` can be garbage collected. This does not apply to stores + * provided by the `asyncLocalStorage`, as those objects are garbage collected + * along with the corresponding async resources. + * + * This method is to be used when the `asyncLocalStorage` is not in use anymore + * in the current process. + */ + disable(): void; + + /** + * This method returns the current store. If this method is called outside of an + * asynchronous context initialized by calling `asyncLocalStorage.run`, it will + * return `undefined`. + */ + getStore(): T | undefined; + + /** + * This methods runs a function synchronously within a context and return its + * return value. The store is not accessible outside of the callback function or + * the asynchronous operations created within the callback. + * + * Optionally, arguments can be passed to the function. They will be passed to the + * callback function. + * + * I the callback function throws an error, it will be thrown by `run` too. The + * stacktrace will not be impacted by this call and the context will be exited. + */ + // TODO: Apply generic vararg once available + run(store: T, callback: (...args: any[]) => R, ...args: any[]): R; + + /** + * This methods runs a function synchronously outside of a context and return its + * return value. The store is not accessible within the callback function or the + * asynchronous operations created within the callback. + * + * Optionally, arguments can be passed to the function. They will be passed to the + * callback function. + * + * If the callback function throws an error, it will be thrown by `exit` too. The + * stacktrace will not be impacted by this call and the context will be + * re-entered. + */ + // TODO: Apply generic vararg once available + exit(callback: (...args: any[]) => R, ...args: any[]): R; + + /** + * Calling `asyncLocalStorage.enterWith(store)` will transition into the context + * for the remainder of the current synchronous execution and will persist + * through any following asynchronous calls. + */ + enterWith(store: T): void; + } } diff --git a/node_modules/@types/node/base.d.ts b/node_modules/@types/node/base.d.ts index 70983d9..fa67179 100644 --- a/node_modules/@types/node/base.d.ts +++ b/node_modules/@types/node/base.d.ts @@ -1,41 +1,19 @@ -// base definnitions for all NodeJS modules that are not specific to any version of TypeScript -/// +// NOTE: These definitions support NodeJS and TypeScript 3.7. + +// NOTE: TypeScript version-specific augmentations can be found in the following paths: +// - ~/base.d.ts - Shared definitions common to all TypeScript versions +// - ~/index.d.ts - Definitions specific to TypeScript 2.1 +// - ~/ts3.7/base.d.ts - Definitions specific to TypeScript 3.7 +// - ~/ts3.7/index.d.ts - Definitions specific to TypeScript 3.7 with assert pulled in + +// Reference required types from the default lib: +/// +/// +/// +/// + +// Base definitions for all NodeJS modules that are not specific to any version of TypeScript: +/// + +// TypeScript 3.7-specific augmentations: /// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// diff --git a/node_modules/@types/node/buffer.d.ts b/node_modules/@types/node/buffer.d.ts index 7eb1061..76c92cf 100644 --- a/node_modules/@types/node/buffer.d.ts +++ b/node_modules/@types/node/buffer.d.ts @@ -13,7 +13,7 @@ declare module "buffer" { export function transcode(source: Uint8Array, fromEnc: TranscodeEncoding, toEnc: TranscodeEncoding): Buffer; export const SlowBuffer: { - /** @deprecated since v6.0.0, use Buffer.allocUnsafeSlow() */ + /** @deprecated since v6.0.0, use `Buffer.allocUnsafeSlow()` */ new(size: number): Buffer; prototype: Buffer; }; diff --git a/node_modules/@types/node/child_process.d.ts b/node_modules/@types/node/child_process.d.ts index c220e19..b53e91e 100644 --- a/node_modules/@types/node/child_process.d.ts +++ b/node_modules/@types/node/child_process.d.ts @@ -1,8 +1,12 @@ declare module "child_process" { + import { BaseEncodingOptions } from 'fs'; import * as events from "events"; import * as net from "net"; import { Writable, Readable, Stream, Pipe } from "stream"; + type Serializable = string | object | number | boolean; + type SendHandle = net.Socket | net.Server; + interface ChildProcess extends events.EventEmitter { stdin: Writable | null; stdout: Readable | null; @@ -18,10 +22,14 @@ declare module "child_process" { readonly killed: boolean; readonly pid: number; readonly connected: boolean; - kill(signal?: string): void; - send(message: any, callback?: (error: Error | null) => void): boolean; - send(message: any, sendHandle?: net.Socket | net.Server, callback?: (error: Error | null) => void): boolean; - send(message: any, sendHandle?: net.Socket | net.Server, options?: MessageOptions, callback?: (error: Error | null) => void): boolean; + readonly exitCode: number | null; + readonly signalCode: NodeJS.Signals | null; + readonly spawnargs: string[]; + readonly spawnfile: string; + kill(signal?: NodeJS.Signals | number): boolean; + send(message: Serializable, callback?: (error: Error | null) => void): boolean; + send(message: Serializable, sendHandle?: SendHandle, callback?: (error: Error | null) => void): boolean; + send(message: Serializable, sendHandle?: SendHandle, options?: MessageOptions, callback?: (error: Error | null) => void): boolean; disconnect(): void; unref(): void; ref(): void; @@ -36,46 +44,46 @@ declare module "child_process" { */ addListener(event: string, listener: (...args: any[]) => void): this; - addListener(event: "close", listener: (code: number, signal: string) => void): this; + addListener(event: "close", listener: (code: number, signal: NodeJS.Signals) => void): this; addListener(event: "disconnect", listener: () => void): this; addListener(event: "error", listener: (err: Error) => void): this; - addListener(event: "exit", listener: (code: number | null, signal: string | null) => void): this; - addListener(event: "message", listener: (message: any, sendHandle: net.Socket | net.Server) => void): this; + addListener(event: "exit", listener: (code: number | null, signal: NodeJS.Signals | null) => void): this; + addListener(event: "message", listener: (message: Serializable, sendHandle: SendHandle) => void): this; emit(event: string | symbol, ...args: any[]): boolean; - emit(event: "close", code: number, signal: string): boolean; + emit(event: "close", code: number, signal: NodeJS.Signals): boolean; emit(event: "disconnect"): boolean; emit(event: "error", err: Error): boolean; - emit(event: "exit", code: number | null, signal: string | null): boolean; - emit(event: "message", message: any, sendHandle: net.Socket | net.Server): boolean; + emit(event: "exit", code: number | null, signal: NodeJS.Signals | null): boolean; + emit(event: "message", message: Serializable, sendHandle: SendHandle): boolean; on(event: string, listener: (...args: any[]) => void): this; - on(event: "close", listener: (code: number, signal: string) => void): this; + on(event: "close", listener: (code: number, signal: NodeJS.Signals) => void): this; on(event: "disconnect", listener: () => void): this; on(event: "error", listener: (err: Error) => void): this; - on(event: "exit", listener: (code: number | null, signal: string | null) => void): this; - on(event: "message", listener: (message: any, sendHandle: net.Socket | net.Server) => void): this; + on(event: "exit", listener: (code: number | null, signal: NodeJS.Signals | null) => void): this; + on(event: "message", listener: (message: Serializable, sendHandle: SendHandle) => void): this; once(event: string, listener: (...args: any[]) => void): this; - once(event: "close", listener: (code: number, signal: string) => void): this; + once(event: "close", listener: (code: number, signal: NodeJS.Signals) => void): this; once(event: "disconnect", listener: () => void): this; once(event: "error", listener: (err: Error) => void): this; - once(event: "exit", listener: (code: number | null, signal: string | null) => void): this; - once(event: "message", listener: (message: any, sendHandle: net.Socket | net.Server) => void): this; + once(event: "exit", listener: (code: number | null, signal: NodeJS.Signals | null) => void): this; + once(event: "message", listener: (message: Serializable, sendHandle: SendHandle) => void): this; prependListener(event: string, listener: (...args: any[]) => void): this; - prependListener(event: "close", listener: (code: number, signal: string) => void): this; + prependListener(event: "close", listener: (code: number, signal: NodeJS.Signals) => void): this; prependListener(event: "disconnect", listener: () => void): this; prependListener(event: "error", listener: (err: Error) => void): this; - prependListener(event: "exit", listener: (code: number | null, signal: string | null) => void): this; - prependListener(event: "message", listener: (message: any, sendHandle: net.Socket | net.Server) => void): this; + prependListener(event: "exit", listener: (code: number | null, signal: NodeJS.Signals | null) => void): this; + prependListener(event: "message", listener: (message: Serializable, sendHandle: SendHandle) => void): this; prependOnceListener(event: string, listener: (...args: any[]) => void): this; - prependOnceListener(event: "close", listener: (code: number, signal: string) => void): this; + prependOnceListener(event: "close", listener: (code: number, signal: NodeJS.Signals) => void): this; prependOnceListener(event: "disconnect", listener: () => void): this; prependOnceListener(event: "error", listener: (err: Error) => void): this; - prependOnceListener(event: "exit", listener: (code: number | null, signal: string | null) => void): this; - prependOnceListener(event: "message", listener: (message: any, sendHandle: net.Socket | net.Server) => void): this; + prependOnceListener(event: "exit", listener: (code: number | null, signal: NodeJS.Signals | null) => void): this; + prependOnceListener(event: "message", listener: (message: Serializable, sendHandle: SendHandle) => void): this; } // return this object when stdio option is undefined or not specified @@ -116,6 +124,16 @@ declare module "child_process" { type StdioOptions = "pipe" | "ignore" | "inherit" | Array<("pipe" | "ipc" | "ignore" | "inherit" | Stream | number | null | undefined)>; + type SerializationType = 'json' | 'advanced'; + + interface MessagingOptions { + /** + * Specify the kind of serialization used for sending messages between processes. + * @default 'json' + */ + serialization?: SerializationType; + } + interface ProcessEnvOptions { uid?: number; gid?: number; @@ -134,14 +152,17 @@ declare module "child_process" { timeout?: number; } - interface SpawnOptions extends CommonOptions { + interface CommonSpawnOptions extends CommonOptions, MessagingOptions { argv0?: string; stdio?: StdioOptions; - detached?: boolean; shell?: boolean | string; windowsVerbatimArguments?: boolean; } + interface SpawnOptions extends CommonSpawnOptions { + detached?: boolean; + } + interface SpawnOptionsWithoutStdio extends SpawnOptions { stdio?: 'pipe' | Array; } @@ -244,7 +265,7 @@ declare module "child_process" { interface ExecOptions extends CommonOptions { shell?: string; maxBuffer?: number; - killSignal?: string; + killSignal?: NodeJS.Signals | number; } interface ExecOptionsWithStringEncoding extends ExecOptions { @@ -252,14 +273,14 @@ declare module "child_process" { } interface ExecOptionsWithBufferEncoding extends ExecOptions { - encoding: string | null; // specify `null`. + encoding: BufferEncoding | null; // specify `null`. } interface ExecException extends Error { cmd?: string; killed?: boolean; code?: number; - signal?: string; + signal?: NodeJS.Signals; } // no `options` definitely means stdout/stderr are `string`. @@ -273,7 +294,11 @@ declare module "child_process" { // `options` with an `encoding` whose type is `string` means stdout/stderr could either be `Buffer` or `string`. // There is no guarantee the `encoding` is unknown as `string` is a superset of `BufferEncoding`. - function exec(command: string, options: { encoding: string } & ExecOptions, callback?: (error: ExecException | null, stdout: string | Buffer, stderr: string | Buffer) => void): ChildProcess; + function exec( + command: string, + options: { encoding: BufferEncoding } & ExecOptions, + callback?: (error: ExecException | null, stdout: string | Buffer, stderr: string | Buffer) => void, + ): ChildProcess; // `options` without an `encoding` means stdout/stderr are definitely `string`. function exec(command: string, options: ExecOptions, callback?: (error: ExecException | null, stdout: string, stderr: string) => void): ChildProcess; @@ -281,7 +306,7 @@ declare module "child_process" { // fallback if nothing else matches. Worst case is always `string | Buffer`. function exec( command: string, - options: ({ encoding?: string | null } & ExecOptions) | undefined | null, + options: (BaseEncodingOptions & ExecOptions) | undefined | null, callback?: (error: ExecException | null, stdout: string | Buffer, stderr: string | Buffer) => void, ): ChildProcess; @@ -295,12 +320,12 @@ declare module "child_process" { function __promisify__(command: string, options: { encoding: "buffer" | null } & ExecOptions): PromiseWithChild<{ stdout: Buffer, stderr: Buffer }>; function __promisify__(command: string, options: { encoding: BufferEncoding } & ExecOptions): PromiseWithChild<{ stdout: string, stderr: string }>; function __promisify__(command: string, options: ExecOptions): PromiseWithChild<{ stdout: string, stderr: string }>; - function __promisify__(command: string, options?: ({ encoding?: string | null } & ExecOptions) | null): PromiseWithChild<{ stdout: string | Buffer, stderr: string | Buffer }>; + function __promisify__(command: string, options?: (BaseEncodingOptions & ExecOptions) | null): PromiseWithChild<{ stdout: string | Buffer, stderr: string | Buffer }>; } interface ExecFileOptions extends CommonOptions { maxBuffer?: number; - killSignal?: string; + killSignal?: NodeJS.Signals | number; windowsVerbatimArguments?: boolean; shell?: boolean | string; } @@ -311,34 +336,34 @@ declare module "child_process" { encoding: 'buffer' | null; } interface ExecFileOptionsWithOtherEncoding extends ExecFileOptions { - encoding: string; + encoding: BufferEncoding; } function execFile(file: string): ChildProcess; - function execFile(file: string, options: ({ encoding?: string | null } & ExecFileOptions) | undefined | null): ChildProcess; + function execFile(file: string, options: (BaseEncodingOptions & ExecFileOptions) | undefined | null): ChildProcess; function execFile(file: string, args?: ReadonlyArray | null): ChildProcess; - function execFile(file: string, args: ReadonlyArray | undefined | null, options: ({ encoding?: string | null } & ExecFileOptions) | undefined | null): ChildProcess; + function execFile(file: string, args: ReadonlyArray | undefined | null, options: (BaseEncodingOptions & ExecFileOptions) | undefined | null): ChildProcess; // no `options` definitely means stdout/stderr are `string`. - function execFile(file: string, callback: (error: Error | null, stdout: string, stderr: string) => void): ChildProcess; - function execFile(file: string, args: ReadonlyArray | undefined | null, callback: (error: Error | null, stdout: string, stderr: string) => void): ChildProcess; + function execFile(file: string, callback: (error: ExecException | null, stdout: string, stderr: string) => void): ChildProcess; + function execFile(file: string, args: ReadonlyArray | undefined | null, callback: (error: ExecException | null, stdout: string, stderr: string) => void): ChildProcess; // `options` with `"buffer"` or `null` for `encoding` means stdout/stderr are definitely `Buffer`. - function execFile(file: string, options: ExecFileOptionsWithBufferEncoding, callback: (error: Error | null, stdout: Buffer, stderr: Buffer) => void): ChildProcess; + function execFile(file: string, options: ExecFileOptionsWithBufferEncoding, callback: (error: ExecException | null, stdout: Buffer, stderr: Buffer) => void): ChildProcess; function execFile( file: string, args: ReadonlyArray | undefined | null, options: ExecFileOptionsWithBufferEncoding, - callback: (error: Error | null, stdout: Buffer, stderr: Buffer) => void, + callback: (error: ExecException | null, stdout: Buffer, stderr: Buffer) => void, ): ChildProcess; // `options` with well known `encoding` means stdout/stderr are definitely `string`. - function execFile(file: string, options: ExecFileOptionsWithStringEncoding, callback: (error: Error | null, stdout: string, stderr: string) => void): ChildProcess; + function execFile(file: string, options: ExecFileOptionsWithStringEncoding, callback: (error: ExecException | null, stdout: string, stderr: string) => void): ChildProcess; function execFile( file: string, args: ReadonlyArray | undefined | null, options: ExecFileOptionsWithStringEncoding, - callback: (error: Error | null, stdout: string, stderr: string) => void, + callback: (error: ExecException | null, stdout: string, stderr: string) => void, ): ChildProcess; // `options` with an `encoding` whose type is `string` means stdout/stderr could either be `Buffer` or `string`. @@ -346,53 +371,62 @@ declare module "child_process" { function execFile( file: string, options: ExecFileOptionsWithOtherEncoding, - callback: (error: Error | null, stdout: string | Buffer, stderr: string | Buffer) => void, + callback: (error: ExecException | null, stdout: string | Buffer, stderr: string | Buffer) => void, ): ChildProcess; function execFile( file: string, args: ReadonlyArray | undefined | null, options: ExecFileOptionsWithOtherEncoding, - callback: (error: Error | null, stdout: string | Buffer, stderr: string | Buffer) => void, + callback: (error: ExecException | null, stdout: string | Buffer, stderr: string | Buffer) => void, ): ChildProcess; // `options` without an `encoding` means stdout/stderr are definitely `string`. - function execFile(file: string, options: ExecFileOptions, callback: (error: Error | null, stdout: string, stderr: string) => void): ChildProcess; - function execFile(file: string, args: ReadonlyArray | undefined | null, options: ExecFileOptions, callback: (error: Error | null, stdout: string, stderr: string) => void): ChildProcess; + function execFile(file: string, options: ExecFileOptions, callback: (error: ExecException | null, stdout: string, stderr: string) => void): ChildProcess; + function execFile( + file: string, + args: ReadonlyArray | undefined | null, + options: ExecFileOptions, + callback: (error: ExecException | null, stdout: string, stderr: string) => void + ): ChildProcess; // fallback if nothing else matches. Worst case is always `string | Buffer`. function execFile( file: string, - options: ({ encoding?: string | null } & ExecFileOptions) | undefined | null, - callback: ((error: Error | null, stdout: string | Buffer, stderr: string | Buffer) => void) | undefined | null, + options: (BaseEncodingOptions & ExecFileOptions) | undefined | null, + callback: ((error: ExecException | null, stdout: string | Buffer, stderr: string | Buffer) => void) | undefined | null, ): ChildProcess; function execFile( file: string, args: ReadonlyArray | undefined | null, - options: ({ encoding?: string | null } & ExecFileOptions) | undefined | null, - callback: ((error: Error | null, stdout: string | Buffer, stderr: string | Buffer) => void) | undefined | null, + options: (BaseEncodingOptions & ExecFileOptions) | undefined | null, + callback: ((error: ExecException | null, stdout: string | Buffer, stderr: string | Buffer) => void) | undefined | null, ): ChildProcess; // NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime. namespace execFile { function __promisify__(file: string): PromiseWithChild<{ stdout: string, stderr: string }>; - function __promisify__(file: string, args: string[] | undefined | null): PromiseWithChild<{ stdout: string, stderr: string }>; + function __promisify__(file: string, args: ReadonlyArray | undefined | null): PromiseWithChild<{ stdout: string, stderr: string }>; function __promisify__(file: string, options: ExecFileOptionsWithBufferEncoding): PromiseWithChild<{ stdout: Buffer, stderr: Buffer }>; - function __promisify__(file: string, args: string[] | undefined | null, options: ExecFileOptionsWithBufferEncoding): PromiseWithChild<{ stdout: Buffer, stderr: Buffer }>; + function __promisify__(file: string, args: ReadonlyArray | undefined | null, options: ExecFileOptionsWithBufferEncoding): PromiseWithChild<{ stdout: Buffer, stderr: Buffer }>; function __promisify__(file: string, options: ExecFileOptionsWithStringEncoding): PromiseWithChild<{ stdout: string, stderr: string }>; - function __promisify__(file: string, args: string[] | undefined | null, options: ExecFileOptionsWithStringEncoding): PromiseWithChild<{ stdout: string, stderr: string }>; + function __promisify__(file: string, args: ReadonlyArray | undefined | null, options: ExecFileOptionsWithStringEncoding): PromiseWithChild<{ stdout: string, stderr: string }>; function __promisify__(file: string, options: ExecFileOptionsWithOtherEncoding): PromiseWithChild<{ stdout: string | Buffer, stderr: string | Buffer }>; - function __promisify__(file: string, args: string[] | undefined | null, options: ExecFileOptionsWithOtherEncoding): PromiseWithChild<{ stdout: string | Buffer, stderr: string | Buffer }>; - function __promisify__(file: string, options: ExecFileOptions): PromiseWithChild<{ stdout: string, stderr: string }>; - function __promisify__(file: string, args: string[] | undefined | null, options: ExecFileOptions): PromiseWithChild<{ stdout: string, stderr: string }>; - function __promisify__(file: string, options: ({ encoding?: string | null } & ExecFileOptions) | undefined | null): PromiseWithChild<{ stdout: string | Buffer, stderr: string | Buffer }>; function __promisify__( file: string, - args: string[] | undefined | null, - options: ({ encoding?: string | null } & ExecFileOptions) | undefined | null, + args: ReadonlyArray | undefined | null, + options: ExecFileOptionsWithOtherEncoding, + ): PromiseWithChild<{ stdout: string | Buffer, stderr: string | Buffer }>; + function __promisify__(file: string, options: ExecFileOptions): PromiseWithChild<{ stdout: string, stderr: string }>; + function __promisify__(file: string, args: ReadonlyArray | undefined | null, options: ExecFileOptions): PromiseWithChild<{ stdout: string, stderr: string }>; + function __promisify__(file: string, options: (BaseEncodingOptions & ExecFileOptions) | undefined | null): PromiseWithChild<{ stdout: string | Buffer, stderr: string | Buffer }>; + function __promisify__( + file: string, + args: ReadonlyArray | undefined | null, + options: (BaseEncodingOptions & ExecFileOptions) | undefined | null, ): PromiseWithChild<{ stdout: string | Buffer, stderr: string | Buffer }>; } - interface ForkOptions extends ProcessEnvOptions { + interface ForkOptions extends ProcessEnvOptions, MessagingOptions { execPath?: string; execArgv?: string[]; silent?: boolean; @@ -400,23 +434,20 @@ declare module "child_process" { detached?: boolean; windowsVerbatimArguments?: boolean; } + function fork(modulePath: string, options?: ForkOptions): ChildProcess; function fork(modulePath: string, args?: ReadonlyArray, options?: ForkOptions): ChildProcess; - interface SpawnSyncOptions extends CommonOptions { - argv0?: string; // Not specified in the docs + interface SpawnSyncOptions extends CommonSpawnOptions { input?: string | NodeJS.ArrayBufferView; - stdio?: StdioOptions; - killSignal?: string | number; + killSignal?: NodeJS.Signals | number; maxBuffer?: number; - encoding?: string; - shell?: boolean | string; - windowsVerbatimArguments?: boolean; + encoding?: BufferEncoding | 'buffer' | null; } interface SpawnSyncOptionsWithStringEncoding extends SpawnSyncOptions { encoding: BufferEncoding; } interface SpawnSyncOptionsWithBufferEncoding extends SpawnSyncOptions { - encoding: string; // specify `null`. + encoding?: 'buffer' | null; } interface SpawnSyncReturns { pid: number; @@ -424,7 +455,7 @@ declare module "child_process" { stdout: T; stderr: T; status: number | null; - signal: string | null; + signal: NodeJS.Signals | null; error?: Error; } function spawnSync(command: string): SpawnSyncReturns; @@ -439,15 +470,15 @@ declare module "child_process" { input?: string | Uint8Array; stdio?: StdioOptions; shell?: string; - killSignal?: string | number; + killSignal?: NodeJS.Signals | number; maxBuffer?: number; - encoding?: string; + encoding?: BufferEncoding | 'buffer' | null; } interface ExecSyncOptionsWithStringEncoding extends ExecSyncOptions { encoding: BufferEncoding; } interface ExecSyncOptionsWithBufferEncoding extends ExecSyncOptions { - encoding: string; // specify `null`. + encoding?: 'buffer' | null; } function execSync(command: string): Buffer; function execSync(command: string, options?: ExecSyncOptionsWithStringEncoding): string; @@ -457,16 +488,16 @@ declare module "child_process" { interface ExecFileSyncOptions extends CommonOptions { input?: string | NodeJS.ArrayBufferView; stdio?: StdioOptions; - killSignal?: string | number; + killSignal?: NodeJS.Signals | number; maxBuffer?: number; - encoding?: string; + encoding?: BufferEncoding; shell?: boolean | string; } interface ExecFileSyncOptionsWithStringEncoding extends ExecFileSyncOptions { encoding: BufferEncoding; } interface ExecFileSyncOptionsWithBufferEncoding extends ExecFileSyncOptions { - encoding: string; // specify `null`. + encoding: BufferEncoding; // specify `null`. } function execFileSync(command: string): Buffer; function execFileSync(command: string, options?: ExecFileSyncOptionsWithStringEncoding): string; diff --git a/node_modules/@types/node/cluster.d.ts b/node_modules/@types/node/cluster.d.ts index 43340ff..0ef6c2a 100644 --- a/node_modules/@types/node/cluster.d.ts +++ b/node_modules/@types/node/cluster.d.ts @@ -24,7 +24,7 @@ declare module "cluster" { class Worker extends events.EventEmitter { id: number; process: child.ChildProcess; - send(message: any, sendHandle?: any, callback?: (error: Error | null) => void): boolean; + send(message: child.Serializable, sendHandle?: child.SendHandle, callback?: (error: Error | null) => void): boolean; kill(signal?: string): void; destroy(signal?: string): void; disconnect(): void; @@ -96,13 +96,14 @@ declare module "cluster" { fork(env?: any): Worker; isMaster: boolean; isWorker: boolean; - // TODO: cluster.schedulingPolicy + schedulingPolicy: number; settings: ClusterSettings; setupMaster(settings?: ClusterSettings): void; worker?: Worker; - workers?: { - [index: string]: Worker | undefined - }; + workers?: NodeJS.Dict; + + readonly SCHED_NONE: number; + readonly SCHED_RR: number; /** * events.EventEmitter @@ -170,17 +171,18 @@ declare module "cluster" { prependOnceListener(event: "setup", listener: (settings: ClusterSettings) => void): this; } + const SCHED_NONE: number; + const SCHED_RR: number; + function disconnect(callback?: () => void): void; function fork(env?: any): Worker; const isMaster: boolean; const isWorker: boolean; - // TODO: cluster.schedulingPolicy + let schedulingPolicy: number; const settings: ClusterSettings; function setupMaster(settings?: ClusterSettings): void; const worker: Worker; - const workers: { - [index: string]: Worker | undefined - }; + const workers: NodeJS.Dict; /** * events.EventEmitter diff --git a/node_modules/@types/node/console.d.ts b/node_modules/@types/node/console.d.ts index d30d13f..178beb4 100644 --- a/node_modules/@types/node/console.d.ts +++ b/node_modules/@types/node/console.d.ts @@ -1,3 +1,133 @@ declare module "console" { + import { InspectOptions } from 'util'; + + global { + // This needs to be global to avoid TS2403 in case lib.dom.d.ts is present in the same build + interface Console { + Console: NodeJS.ConsoleConstructor; + /** + * A simple assertion test that verifies whether `value` is truthy. + * If it is not, an `AssertionError` is thrown. + * If provided, the error `message` is formatted using `util.format()` and used as the error message. + */ + assert(value: any, message?: string, ...optionalParams: any[]): void; + /** + * When `stdout` is a TTY, calling `console.clear()` will attempt to clear the TTY. + * When `stdout` is not a TTY, this method does nothing. + */ + clear(): void; + /** + * Maintains an internal counter specific to `label` and outputs to `stdout` the number of times `console.count()` has been called with the given `label`. + */ + count(label?: string): void; + /** + * Resets the internal counter specific to `label`. + */ + countReset(label?: string): void; + /** + * The `console.debug()` function is an alias for {@link console.log()}. + */ + debug(message?: any, ...optionalParams: any[]): void; + /** + * Uses {@link util.inspect()} on `obj` and prints the resulting string to `stdout`. + * This function bypasses any custom `inspect()` function defined on `obj`. + */ + dir(obj: any, options?: InspectOptions): void; + /** + * This method calls {@link console.log()} passing it the arguments received. Please note that this method does not produce any XML formatting + */ + dirxml(...data: any[]): void; + /** + * Prints to `stderr` with newline. + */ + error(message?: any, ...optionalParams: any[]): void; + /** + * Increases indentation of subsequent lines by two spaces. + * If one or more `label`s are provided, those are printed first without the additional indentation. + */ + group(...label: any[]): void; + /** + * The `console.groupCollapsed()` function is an alias for {@link console.group()}. + */ + groupCollapsed(...label: any[]): void; + /** + * Decreases indentation of subsequent lines by two spaces. + */ + groupEnd(): void; + /** + * The {@link console.info()} function is an alias for {@link console.log()}. + */ + info(message?: any, ...optionalParams: any[]): void; + /** + * Prints to `stdout` with newline. + */ + log(message?: any, ...optionalParams: any[]): void; + /** + * This method does not display anything unless used in the inspector. + * Prints to `stdout` the array `array` formatted as a table. + */ + table(tabularData: any, properties?: ReadonlyArray): void; + /** + * Starts a timer that can be used to compute the duration of an operation. Timers are identified by a unique `label`. + */ + time(label?: string): void; + /** + * Stops a timer that was previously started by calling {@link console.time()} and prints the result to `stdout`. + */ + timeEnd(label?: string): void; + /** + * For a timer that was previously started by calling {@link console.time()}, prints the elapsed time and other `data` arguments to `stdout`. + */ + timeLog(label?: string, ...data: any[]): void; + /** + * Prints to `stderr` the string 'Trace :', followed by the {@link util.format()} formatted message and stack trace to the current position in the code. + */ + trace(message?: any, ...optionalParams: any[]): void; + /** + * The {@link console.warn()} function is an alias for {@link console.error()}. + */ + warn(message?: any, ...optionalParams: any[]): void; + + // --- Inspector mode only --- + /** + * This method does not display anything unless used in the inspector. + * Starts a JavaScript CPU profile with an optional label. + */ + profile(label?: string): void; + /** + * This method does not display anything unless used in the inspector. + * Stops the current JavaScript CPU profiling session if one has been started and prints the report to the Profiles panel of the inspector. + */ + profileEnd(label?: string): void; + /** + * This method does not display anything unless used in the inspector. + * Adds an event with the label `label` to the Timeline panel of the inspector. + */ + timeStamp(label?: string): void; + } + + var console: Console; + + namespace NodeJS { + interface ConsoleConstructorOptions { + stdout: WritableStream; + stderr?: WritableStream; + ignoreErrors?: boolean; + colorMode?: boolean | 'auto'; + inspectOptions?: InspectOptions; + } + + interface ConsoleConstructor { + prototype: Console; + new(stdout: WritableStream, stderr?: WritableStream, ignoreErrors?: boolean): Console; + new(options: ConsoleConstructorOptions): Console; + } + + interface Global { + console: typeof console; + } + } + } + export = console; } diff --git a/node_modules/@types/node/constants.d.ts b/node_modules/@types/node/constants.d.ts index ebd463b..d124ae6 100644 --- a/node_modules/@types/node/constants.d.ts +++ b/node_modules/@types/node/constants.d.ts @@ -1,448 +1,8 @@ /** @deprecated since v6.3.0 - use constants property exposed by the relevant module instead. */ declare module "constants" { - /** @deprecated since v6.3.0 - use `os.constants.errno.E2BIG` instead. */ - const E2BIG: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.EACCES` instead. */ - const EACCES: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.EADDRINUSE` instead. */ - const EADDRINUSE: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.EADDRNOTAVAIL` instead. */ - const EADDRNOTAVAIL: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.EAFNOSUPPORT` instead. */ - const EAFNOSUPPORT: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.EAGAIN` instead. */ - const EAGAIN: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.EALREADY` instead. */ - const EALREADY: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.EBADF` instead. */ - const EBADF: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.EBADMSG` instead. */ - const EBADMSG: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.EBUSY` instead. */ - const EBUSY: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.ECANCELED` instead. */ - const ECANCELED: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.ECHILD` instead. */ - const ECHILD: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.ECONNABORTED` instead. */ - const ECONNABORTED: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.ECONNREFUSED` instead. */ - const ECONNREFUSED: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.ECONNRESET` instead. */ - const ECONNRESET: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.EDEADLK` instead. */ - const EDEADLK: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.EDESTADDRREQ` instead. */ - const EDESTADDRREQ: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.EDOM` instead. */ - const EDOM: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.EEXIST` instead. */ - const EEXIST: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.EFAULT` instead. */ - const EFAULT: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.EFBIG` instead. */ - const EFBIG: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.EHOSTUNREACH` instead. */ - const EHOSTUNREACH: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.EIDRM` instead. */ - const EIDRM: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.EILSEQ` instead. */ - const EILSEQ: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.EINPROGRESS` instead. */ - const EINPROGRESS: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.EINTR` instead. */ - const EINTR: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.EINVAL` instead. */ - const EINVAL: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.EIO` instead. */ - const EIO: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.EISCONN` instead. */ - const EISCONN: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.EISDIR` instead. */ - const EISDIR: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.ELOOP` instead. */ - const ELOOP: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.EMFILE` instead. */ - const EMFILE: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.EMLINK` instead. */ - const EMLINK: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.EMSGSIZE` instead. */ - const EMSGSIZE: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.ENAMETOOLONG` instead. */ - const ENAMETOOLONG: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.ENETDOWN` instead. */ - const ENETDOWN: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.ENETRESET` instead. */ - const ENETRESET: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.ENETUNREACH` instead. */ - const ENETUNREACH: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.ENFILE` instead. */ - const ENFILE: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.ENOBUFS` instead. */ - const ENOBUFS: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.ENODATA` instead. */ - const ENODATA: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.ENODEV` instead. */ - const ENODEV: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.ENOENT` instead. */ - const ENOENT: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.ENOEXEC` instead. */ - const ENOEXEC: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.ENOLCK` instead. */ - const ENOLCK: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.ENOLINK` instead. */ - const ENOLINK: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.ENOMEM` instead. */ - const ENOMEM: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.ENOMSG` instead. */ - const ENOMSG: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.ENOPROTOOPT` instead. */ - const ENOPROTOOPT: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.ENOSPC` instead. */ - const ENOSPC: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.ENOSR` instead. */ - const ENOSR: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.ENOSTR` instead. */ - const ENOSTR: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.ENOSYS` instead. */ - const ENOSYS: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.ENOTCONN` instead. */ - const ENOTCONN: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.ENOTDIR` instead. */ - const ENOTDIR: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.ENOTEMPTY` instead. */ - const ENOTEMPTY: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.ENOTSOCK` instead. */ - const ENOTSOCK: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.ENOTSUP` instead. */ - const ENOTSUP: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.ENOTTY` instead. */ - const ENOTTY: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.ENXIO` instead. */ - const ENXIO: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.EOPNOTSUPP` instead. */ - const EOPNOTSUPP: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.EOVERFLOW` instead. */ - const EOVERFLOW: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.EPERM` instead. */ - const EPERM: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.EPIPE` instead. */ - const EPIPE: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.EPROTO` instead. */ - const EPROTO: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.EPROTONOSUPPORT` instead. */ - const EPROTONOSUPPORT: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.EPROTOTYPE` instead. */ - const EPROTOTYPE: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.ERANGE` instead. */ - const ERANGE: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.EROFS` instead. */ - const EROFS: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.ESPIPE` instead. */ - const ESPIPE: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.ESRCH` instead. */ - const ESRCH: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.ETIME` instead. */ - const ETIME: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.ETIMEDOUT` instead. */ - const ETIMEDOUT: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.ETXTBSY` instead. */ - const ETXTBSY: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.EWOULDBLOCK` instead. */ - const EWOULDBLOCK: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.EXDEV` instead. */ - const EXDEV: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAEINTR` instead. */ - const WSAEINTR: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAEBADF` instead. */ - const WSAEBADF: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAEACCES` instead. */ - const WSAEACCES: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAEFAULT` instead. */ - const WSAEFAULT: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAEINVAL` instead. */ - const WSAEINVAL: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAEMFILE` instead. */ - const WSAEMFILE: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAEWOULDBLOCK` instead. */ - const WSAEWOULDBLOCK: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAEINPROGRESS` instead. */ - const WSAEINPROGRESS: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAEALREADY` instead. */ - const WSAEALREADY: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAENOTSOCK` instead. */ - const WSAENOTSOCK: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAEDESTADDRREQ` instead. */ - const WSAEDESTADDRREQ: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAEMSGSIZE` instead. */ - const WSAEMSGSIZE: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAEPROTOTYPE` instead. */ - const WSAEPROTOTYPE: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAENOPROTOOPT` instead. */ - const WSAENOPROTOOPT: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAEPROTONOSUPPORT` instead. */ - const WSAEPROTONOSUPPORT: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAESOCKTNOSUPPORT` instead. */ - const WSAESOCKTNOSUPPORT: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAEOPNOTSUPP` instead. */ - const WSAEOPNOTSUPP: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAEPFNOSUPPORT` instead. */ - const WSAEPFNOSUPPORT: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAEAFNOSUPPORT` instead. */ - const WSAEAFNOSUPPORT: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAEADDRINUSE` instead. */ - const WSAEADDRINUSE: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAEADDRNOTAVAIL` instead. */ - const WSAEADDRNOTAVAIL: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAENETDOWN` instead. */ - const WSAENETDOWN: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAENETUNREACH` instead. */ - const WSAENETUNREACH: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAENETRESET` instead. */ - const WSAENETRESET: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAECONNABORTED` instead. */ - const WSAECONNABORTED: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAECONNRESET` instead. */ - const WSAECONNRESET: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAENOBUFS` instead. */ - const WSAENOBUFS: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAEISCONN` instead. */ - const WSAEISCONN: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAENOTCONN` instead. */ - const WSAENOTCONN: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAESHUTDOWN` instead. */ - const WSAESHUTDOWN: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAETOOMANYREFS` instead. */ - const WSAETOOMANYREFS: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAETIMEDOUT` instead. */ - const WSAETIMEDOUT: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAECONNREFUSED` instead. */ - const WSAECONNREFUSED: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAELOOP` instead. */ - const WSAELOOP: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAENAMETOOLONG` instead. */ - const WSAENAMETOOLONG: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAEHOSTDOWN` instead. */ - const WSAEHOSTDOWN: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAEHOSTUNREACH` instead. */ - const WSAEHOSTUNREACH: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAENOTEMPTY` instead. */ - const WSAENOTEMPTY: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAEPROCLIM` instead. */ - const WSAEPROCLIM: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAEUSERS` instead. */ - const WSAEUSERS: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAEDQUOT` instead. */ - const WSAEDQUOT: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAESTALE` instead. */ - const WSAESTALE: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAEREMOTE` instead. */ - const WSAEREMOTE: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSASYSNOTREADY` instead. */ - const WSASYSNOTREADY: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAVERNOTSUPPORTED` instead. */ - const WSAVERNOTSUPPORTED: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSANOTINITIALISED` instead. */ - const WSANOTINITIALISED: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAEDISCON` instead. */ - const WSAEDISCON: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAENOMORE` instead. */ - const WSAENOMORE: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAECANCELLED` instead. */ - const WSAECANCELLED: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAEINVALIDPROCTABLE` instead. */ - const WSAEINVALIDPROCTABLE: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAEINVALIDPROVIDER` instead. */ - const WSAEINVALIDPROVIDER: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAEPROVIDERFAILEDINIT` instead. */ - const WSAEPROVIDERFAILEDINIT: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSASYSCALLFAILURE` instead. */ - const WSASYSCALLFAILURE: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSASERVICE_NOT_FOUND` instead. */ - const WSASERVICE_NOT_FOUND: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSATYPE_NOT_FOUND` instead. */ - const WSATYPE_NOT_FOUND: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSA_E_NO_MORE` instead. */ - const WSA_E_NO_MORE: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSA_E_CANCELLED` instead. */ - const WSA_E_CANCELLED: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAEREFUSED` instead. */ - const WSAEREFUSED: number; - /** @deprecated since v6.3.0 - use `os.constants.signals.SIGHUP` instead. */ - const SIGHUP: number; - /** @deprecated since v6.3.0 - use `os.constants.signals.SIGINT` instead. */ - const SIGINT: number; - /** @deprecated since v6.3.0 - use `os.constants.signals.SIGILL` instead. */ - const SIGILL: number; - /** @deprecated since v6.3.0 - use `os.constants.signals.SIGABRT` instead. */ - const SIGABRT: number; - /** @deprecated since v6.3.0 - use `os.constants.signals.SIGFPE` instead. */ - const SIGFPE: number; - /** @deprecated since v6.3.0 - use `os.constants.signals.SIGKILL` instead. */ - const SIGKILL: number; - /** @deprecated since v6.3.0 - use `os.constants.signals.SIGSEGV` instead. */ - const SIGSEGV: number; - /** @deprecated since v6.3.0 - use `os.constants.signals.SIGTERM` instead. */ - const SIGTERM: number; - /** @deprecated since v6.3.0 - use `os.constants.signals.SIGBREAK` instead. */ - const SIGBREAK: number; - /** @deprecated since v6.3.0 - use `os.constants.signals.SIGWINCH` instead. */ - const SIGWINCH: number; - const SSL_OP_ALL: number; - const SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION: number; - const SSL_OP_CIPHER_SERVER_PREFERENCE: number; - const SSL_OP_CISCO_ANYCONNECT: number; - const SSL_OP_COOKIE_EXCHANGE: number; - const SSL_OP_CRYPTOPRO_TLSEXT_BUG: number; - const SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS: number; - const SSL_OP_EPHEMERAL_RSA: number; - const SSL_OP_LEGACY_SERVER_CONNECT: number; - const SSL_OP_MICROSOFT_BIG_SSLV3_BUFFER: number; - const SSL_OP_MICROSOFT_SESS_ID_BUG: number; - const SSL_OP_MSIE_SSLV2_RSA_PADDING: number; - const SSL_OP_NETSCAPE_CA_DN_BUG: number; - const SSL_OP_NETSCAPE_CHALLENGE_BUG: number; - const SSL_OP_NETSCAPE_DEMO_CIPHER_CHANGE_BUG: number; - const SSL_OP_NETSCAPE_REUSE_CIPHER_CHANGE_BUG: number; - const SSL_OP_NO_COMPRESSION: number; - const SSL_OP_NO_QUERY_MTU: number; - const SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION: number; - const SSL_OP_NO_SSLv2: number; - const SSL_OP_NO_SSLv3: number; - const SSL_OP_NO_TICKET: number; - const SSL_OP_NO_TLSv1: number; - const SSL_OP_NO_TLSv1_1: number; - const SSL_OP_NO_TLSv1_2: number; - const SSL_OP_PKCS1_CHECK_1: number; - const SSL_OP_PKCS1_CHECK_2: number; - const SSL_OP_SINGLE_DH_USE: number; - const SSL_OP_SINGLE_ECDH_USE: number; - const SSL_OP_SSLEAY_080_CLIENT_DH_BUG: number; - const SSL_OP_SSLREF2_REUSE_CERT_TYPE_BUG: number; - const SSL_OP_TLS_BLOCK_PADDING_BUG: number; - const SSL_OP_TLS_D5_BUG: number; - const SSL_OP_TLS_ROLLBACK_BUG: number; - const ENGINE_METHOD_DSA: number; - const ENGINE_METHOD_DH: number; - const ENGINE_METHOD_RAND: number; - const ENGINE_METHOD_ECDH: number; - const ENGINE_METHOD_ECDSA: number; - const ENGINE_METHOD_CIPHERS: number; - const ENGINE_METHOD_DIGESTS: number; - const ENGINE_METHOD_STORE: number; - const ENGINE_METHOD_PKEY_METHS: number; - const ENGINE_METHOD_PKEY_ASN1_METHS: number; - const ENGINE_METHOD_ALL: number; - const ENGINE_METHOD_NONE: number; - const DH_CHECK_P_NOT_SAFE_PRIME: number; - const DH_CHECK_P_NOT_PRIME: number; - const DH_UNABLE_TO_CHECK_GENERATOR: number; - const DH_NOT_SUITABLE_GENERATOR: number; - const RSA_PKCS1_PADDING: number; - const RSA_SSLV23_PADDING: number; - const RSA_NO_PADDING: number; - const RSA_PKCS1_OAEP_PADDING: number; - const RSA_X931_PADDING: number; - const RSA_PKCS1_PSS_PADDING: number; - const POINT_CONVERSION_COMPRESSED: number; - const POINT_CONVERSION_UNCOMPRESSED: number; - const POINT_CONVERSION_HYBRID: number; - const O_RDONLY: number; - const O_WRONLY: number; - const O_RDWR: number; - const S_IFMT: number; - const S_IFREG: number; - const S_IFDIR: number; - const S_IFCHR: number; - const S_IFBLK: number; - const S_IFIFO: number; - const S_IFSOCK: number; - const S_IRWXU: number; - const S_IRUSR: number; - const S_IWUSR: number; - const S_IXUSR: number; - const S_IRWXG: number; - const S_IRGRP: number; - const S_IWGRP: number; - const S_IXGRP: number; - const S_IRWXO: number; - const S_IROTH: number; - const S_IWOTH: number; - const S_IXOTH: number; - const S_IFLNK: number; - const O_CREAT: number; - const O_EXCL: number; - const O_NOCTTY: number; - const O_DIRECTORY: number; - const O_NOATIME: number; - const O_NOFOLLOW: number; - const O_SYNC: number; - const O_DSYNC: number; - const O_SYMLINK: number; - const O_DIRECT: number; - const O_NONBLOCK: number; - const O_TRUNC: number; - const O_APPEND: number; - const F_OK: number; - const R_OK: number; - const W_OK: number; - const X_OK: number; - const COPYFILE_EXCL: number; - const COPYFILE_FICLONE: number; - const COPYFILE_FICLONE_FORCE: number; - const UV_UDP_REUSEADDR: number; - /** @deprecated since v6.3.0 - use `os.constants.signals.SIGQUIT` instead. */ - const SIGQUIT: number; - /** @deprecated since v6.3.0 - use `os.constants.signals.SIGTRAP` instead. */ - const SIGTRAP: number; - /** @deprecated since v6.3.0 - use `os.constants.signals.SIGIOT` instead. */ - const SIGIOT: number; - /** @deprecated since v6.3.0 - use `os.constants.signals.SIGBUS` instead. */ - const SIGBUS: number; - /** @deprecated since v6.3.0 - use `os.constants.signals.SIGUSR1` instead. */ - const SIGUSR1: number; - /** @deprecated since v6.3.0 - use `os.constants.signals.SIGUSR2` instead. */ - const SIGUSR2: number; - /** @deprecated since v6.3.0 - use `os.constants.signals.SIGPIPE` instead. */ - const SIGPIPE: number; - /** @deprecated since v6.3.0 - use `os.constants.signals.SIGALRM` instead. */ - const SIGALRM: number; - /** @deprecated since v6.3.0 - use `os.constants.signals.SIGCHLD` instead. */ - const SIGCHLD: number; - /** @deprecated since v6.3.0 - use `os.constants.signals.SIGSTKFLT` instead. */ - const SIGSTKFLT: number; - /** @deprecated since v6.3.0 - use `os.constants.signals.SIGCONT` instead. */ - const SIGCONT: number; - /** @deprecated since v6.3.0 - use `os.constants.signals.SIGSTOP` instead. */ - const SIGSTOP: number; - /** @deprecated since v6.3.0 - use `os.constants.signals.SIGTSTP` instead. */ - const SIGTSTP: number; - /** @deprecated since v6.3.0 - use `os.constants.signals.SIGTTIN` instead. */ - const SIGTTIN: number; - /** @deprecated since v6.3.0 - use `os.constants.signals.SIGTTOU` instead. */ - const SIGTTOU: number; - /** @deprecated since v6.3.0 - use `os.constants.signals.SIGURG` instead. */ - const SIGURG: number; - /** @deprecated since v6.3.0 - use `os.constants.signals.SIGXCPU` instead. */ - const SIGXCPU: number; - /** @deprecated since v6.3.0 - use `os.constants.signals.SIGXFSZ` instead. */ - const SIGXFSZ: number; - /** @deprecated since v6.3.0 - use `os.constants.signals.SIGVTALRM` instead. */ - const SIGVTALRM: number; - /** @deprecated since v6.3.0 - use `os.constants.signals.SIGPROF` instead. */ - const SIGPROF: number; - /** @deprecated since v6.3.0 - use `os.constants.signals.SIGIO` instead. */ - const SIGIO: number; - /** @deprecated since v6.3.0 - use `os.constants.signals.SIGPOLL` instead. */ - const SIGPOLL: number; - /** @deprecated since v6.3.0 - use `os.constants.signals.SIGPWR` instead. */ - const SIGPWR: number; - /** @deprecated since v6.3.0 - use `os.constants.signals.SIGSYS` instead. */ - const SIGSYS: number; - /** @deprecated since v6.3.0 - use `os.constants.signals.SIGUNUSED` instead. */ - const SIGUNUSED: number; - const defaultCoreCipherList: string; - const defaultCipherList: string; - const ENGINE_METHOD_RSA: number; - const ALPN_ENABLED: number; + import { constants as osConstants, SignalConstants } from 'os'; + import { constants as cryptoConstants } from 'crypto'; + import { constants as fsConstants } from 'fs'; + const exp: typeof osConstants.errno & typeof osConstants.priority & SignalConstants & typeof cryptoConstants & typeof fsConstants; + export = exp; } diff --git a/node_modules/@types/node/crypto.d.ts b/node_modules/@types/node/crypto.d.ts index ee0dd7f..17660cf 100644 --- a/node_modules/@types/node/crypto.d.ts +++ b/node_modules/@types/node/crypto.d.ts @@ -118,7 +118,7 @@ declare module "crypto" { const fips: boolean; function createHash(algorithm: string, options?: HashOptions): Hash; - function createHmac(algorithm: string, key: BinaryLike, options?: stream.TransformOptions): Hmac; + function createHmac(algorithm: string, key: BinaryLike | KeyObject, options?: stream.TransformOptions): Hmac; type Utf8AsciiLatin1Encoding = "utf8" | "ascii" | "latin1"; type HexBase64Latin1Encoding = "latin1" | "hex" | "base64"; @@ -128,6 +128,7 @@ declare module "crypto" { class Hash extends stream.Transform { private constructor(); + copy(): Hash; update(data: BinaryLike): Hash; update(data: string, input_encoding: Utf8AsciiLatin1Encoding): Hash; digest(): Buffer; @@ -160,11 +161,11 @@ declare module "crypto" { asymmetricKeySize?: number; export(options: KeyExportOptions<'pem'>): string | Buffer; export(options?: KeyExportOptions<'der'>): Buffer; - symmetricSize?: number; + symmetricKeySize?: number; type: KeyObjectType; } - type CipherCCMTypes = 'aes-128-ccm' | 'aes-192-ccm' | 'aes-256-ccm'; + type CipherCCMTypes = 'aes-128-ccm' | 'aes-192-ccm' | 'aes-256-ccm' | 'chacha20-poly1305'; type CipherGCMTypes = 'aes-128-gcm' | 'aes-192-gcm' | 'aes-256-gcm'; type BinaryLike = string | NodeJS.ArrayBufferView; @@ -177,11 +178,11 @@ declare module "crypto" { interface CipherGCMOptions extends stream.TransformOptions { authTagLength?: number; } - /** @deprecated since v10.0.0 use createCipheriv() */ + /** @deprecated since v10.0.0 use `createCipheriv()` */ function createCipher(algorithm: CipherCCMTypes, password: BinaryLike, options: CipherCCMOptions): CipherCCM; - /** @deprecated since v10.0.0 use createCipheriv() */ + /** @deprecated since v10.0.0 use `createCipheriv()` */ function createCipher(algorithm: CipherGCMTypes, password: BinaryLike, options?: CipherGCMOptions): CipherGCM; - /** @deprecated since v10.0.0 use createCipheriv() */ + /** @deprecated since v10.0.0 use `createCipheriv()` */ function createCipher(algorithm: string, password: BinaryLike, options?: stream.TransformOptions): Cipher; function createCipheriv( @@ -207,39 +208,39 @@ declare module "crypto" { update(data: NodeJS.ArrayBufferView, input_encoding: undefined, output_encoding: HexBase64BinaryEncoding): string; update(data: string, input_encoding: Utf8AsciiBinaryEncoding | undefined, output_encoding: HexBase64BinaryEncoding): string; final(): Buffer; - final(output_encoding: string): string; + final(output_encoding: BufferEncoding): string; setAutoPadding(auto_padding?: boolean): this; // getAuthTag(): Buffer; - // setAAD(buffer: Buffer): this; // docs only say buffer + // setAAD(buffer: NodeJS.ArrayBufferView): this; } interface CipherCCM extends Cipher { - setAAD(buffer: Buffer, options: { plaintextLength: number }): this; + setAAD(buffer: NodeJS.ArrayBufferView, options: { plaintextLength: number }): this; getAuthTag(): Buffer; } interface CipherGCM extends Cipher { - setAAD(buffer: Buffer, options?: { plaintextLength: number }): this; + setAAD(buffer: NodeJS.ArrayBufferView, options?: { plaintextLength: number }): this; getAuthTag(): Buffer; } - /** @deprecated since v10.0.0 use createCipheriv() */ + /** @deprecated since v10.0.0 use `createDecipheriv()` */ function createDecipher(algorithm: CipherCCMTypes, password: BinaryLike, options: CipherCCMOptions): DecipherCCM; - /** @deprecated since v10.0.0 use createCipheriv() */ + /** @deprecated since v10.0.0 use `createDecipheriv()` */ function createDecipher(algorithm: CipherGCMTypes, password: BinaryLike, options?: CipherGCMOptions): DecipherGCM; - /** @deprecated since v10.0.0 use createCipheriv() */ + /** @deprecated since v10.0.0 use `createDecipheriv()` */ function createDecipher(algorithm: string, password: BinaryLike, options?: stream.TransformOptions): Decipher; function createDecipheriv( algorithm: CipherCCMTypes, - key: BinaryLike, + key: CipherKey, iv: BinaryLike | null, options: CipherCCMOptions, ): DecipherCCM; function createDecipheriv( algorithm: CipherGCMTypes, - key: BinaryLike, + key: CipherKey, iv: BinaryLike | null, options?: CipherGCMOptions, ): DecipherGCM; - function createDecipheriv(algorithm: string, key: BinaryLike, iv: BinaryLike | null, options?: stream.TransformOptions): Decipher; + function createDecipheriv(algorithm: string, key: CipherKey, iv: BinaryLike | null, options?: stream.TransformOptions): Decipher; class Decipher extends stream.Transform { private constructor(); @@ -248,7 +249,7 @@ declare module "crypto" { update(data: NodeJS.ArrayBufferView, input_encoding: HexBase64BinaryEncoding | undefined, output_encoding: Utf8AsciiBinaryEncoding): string; update(data: string, input_encoding: HexBase64BinaryEncoding | undefined, output_encoding: Utf8AsciiBinaryEncoding): string; final(): Buffer; - final(output_encoding: string): string; + final(output_encoding: BufferEncoding): string; setAutoPadding(auto_padding?: boolean): this; // setAuthTag(tag: NodeJS.ArrayBufferView): this; // setAAD(buffer: NodeJS.ArrayBufferView): this; @@ -277,20 +278,31 @@ declare module "crypto" { function createPrivateKey(key: PrivateKeyInput | string | Buffer): KeyObject; function createPublicKey(key: PublicKeyInput | string | Buffer | KeyObject): KeyObject; - function createSecretKey(key: Buffer): KeyObject; + function createSecretKey(key: NodeJS.ArrayBufferView): KeyObject; function createSign(algorithm: string, options?: stream.WritableOptions): Signer; + type DSAEncoding = 'der' | 'ieee-p1363'; + interface SigningOptions { /** * @See crypto.constants.RSA_PKCS1_PADDING */ padding?: number; saltLength?: number; + dsaEncoding?: DSAEncoding; } interface SignPrivateKeyInput extends PrivateKeyInput, SigningOptions { } + interface SignKeyObjectInput extends SigningOptions { + key: KeyObject; + } + interface VerifyPublicKeyInput extends PublicKeyInput, SigningOptions { + } + interface VerifyKeyObjectInput extends SigningOptions { + key: KeyObject; + } type KeyLike = string | Buffer | KeyObject; @@ -299,8 +311,8 @@ declare module "crypto" { update(data: BinaryLike): Signer; update(data: string, input_encoding: Utf8AsciiLatin1Encoding): Signer; - sign(private_key: SignPrivateKeyInput | KeyLike): Buffer; - sign(private_key: SignPrivateKeyInput | KeyLike, output_format: HexBase64Latin1Encoding): string; + sign(private_key: KeyLike | SignKeyObjectInput | SignPrivateKeyInput): Buffer; + sign(private_key: KeyLike | SignKeyObjectInput | SignPrivateKeyInput, output_format: HexBase64Latin1Encoding): string; } function createVerify(algorithm: string, options?: stream.WritableOptions): Verify; @@ -309,8 +321,8 @@ declare module "crypto" { update(data: BinaryLike): Verify; update(data: string, input_encoding: Utf8AsciiLatin1Encoding): Verify; - verify(object: Object | KeyLike, signature: NodeJS.ArrayBufferView): boolean; - verify(object: Object | KeyLike, signature: string, signature_format?: HexBase64Latin1Encoding): boolean; + verify(object: KeyLike | VerifyKeyObjectInput | VerifyPublicKeyInput, signature: NodeJS.ArrayBufferView): boolean; + verify(object: KeyLike | VerifyKeyObjectInput | VerifyPublicKeyInput, signature: string, signature_format?: HexBase64Latin1Encoding): boolean; // https://nodejs.org/api/crypto.html#crypto_verifier_verify_object_signature_signature_format // The signature field accepts a TypedArray type, but it is only available starting ES2017 } @@ -336,9 +348,9 @@ declare module "crypto" { getPrivateKey(): Buffer; getPrivateKey(encoding: HexBase64Latin1Encoding): string; setPublicKey(public_key: NodeJS.ArrayBufferView): void; - setPublicKey(public_key: string, encoding: string): void; + setPublicKey(public_key: string, encoding: BufferEncoding): void; setPrivateKey(private_key: NodeJS.ArrayBufferView): void; - setPrivateKey(private_key: string, encoding: string): void; + setPrivateKey(private_key: string, encoding: BufferEncoding): void; verifyError: number; } function getDiffieHellman(group_name: string): DiffieHellman; @@ -357,6 +369,11 @@ declare module "crypto" { function pseudoRandomBytes(size: number): Buffer; function pseudoRandomBytes(size: number, callback: (err: Error | null, buf: Buffer) => void): void; + function randomInt(max: number): number; + function randomInt(min: number, max: number): number; + function randomInt(max: number, callback: (err: Error | null, value: number) => void): void; + function randomInt(min: number, max: number, callback: (err: Error | null, value: number) => void): void; + function randomFillSync(buffer: T, offset?: number, size?: number): T; function randomFill(buffer: T, callback: (err: Error | null, buf: T) => void): void; function randomFill(buffer: T, offset: number, callback: (err: Error | null, buf: T) => void): void; @@ -402,6 +419,7 @@ declare module "crypto" { function privateEncrypt(private_key: RsaPrivateKey | KeyLike, buffer: NodeJS.ArrayBufferView): Buffer; function getCiphers(): string[]; function getCurves(): string[]; + function getFips(): 1 | 0; function getHashes(): string[]; class ECDH { private constructor(); @@ -428,9 +446,9 @@ declare module "crypto" { function createECDH(curve_name: string): ECDH; function timingSafeEqual(a: NodeJS.ArrayBufferView, b: NodeJS.ArrayBufferView): boolean; /** @deprecated since v10.0.0 */ - const DEFAULT_ENCODING: string; + const DEFAULT_ENCODING: BufferEncoding; - type KeyType = 'rsa' | 'dsa' | 'ec'; + type KeyType = 'rsa' | 'dsa' | 'ec' | 'ed25519' | 'ed448' | 'x25519' | 'x448'; type KeyFormat = 'pem' | 'der'; interface BasePrivateKeyEncodingOptions { @@ -444,6 +462,30 @@ declare module "crypto" { privateKey: KeyObject; } + interface ED25519KeyPairKeyObjectOptions { + /** + * No options. + */ + } + + interface ED448KeyPairKeyObjectOptions { + /** + * No options. + */ + } + + interface X25519KeyPairKeyObjectOptions { + /** + * No options. + */ + } + + interface X448KeyPairKeyObjectOptions { + /** + * No options. + */ + } + interface ECKeyPairKeyObjectOptions { /** * Name of the curve to use. @@ -528,6 +570,46 @@ declare module "crypto" { }; } + interface ED25519KeyPairOptions { + publicKeyEncoding: { + type: 'spki'; + format: PubF; + }; + privateKeyEncoding: BasePrivateKeyEncodingOptions & { + type: 'pkcs8'; + }; + } + + interface ED448KeyPairOptions { + publicKeyEncoding: { + type: 'spki'; + format: PubF; + }; + privateKeyEncoding: BasePrivateKeyEncodingOptions & { + type: 'pkcs8'; + }; + } + + interface X25519KeyPairOptions { + publicKeyEncoding: { + type: 'spki'; + format: PubF; + }; + privateKeyEncoding: BasePrivateKeyEncodingOptions & { + type: 'pkcs8'; + }; + } + + interface X448KeyPairOptions { + publicKeyEncoding: { + type: 'spki'; + format: PubF; + }; + privateKeyEncoding: BasePrivateKeyEncodingOptions & { + type: 'pkcs8'; + }; + } + interface KeyPairSyncResult { publicKey: T1; privateKey: T2; @@ -551,6 +633,30 @@ declare module "crypto" { function generateKeyPairSync(type: 'ec', options: ECKeyPairOptions<'der', 'der'>): KeyPairSyncResult; function generateKeyPairSync(type: 'ec', options: ECKeyPairKeyObjectOptions): KeyPairKeyObjectResult; + function generateKeyPairSync(type: 'ed25519', options: ED25519KeyPairOptions<'pem', 'pem'>): KeyPairSyncResult; + function generateKeyPairSync(type: 'ed25519', options: ED25519KeyPairOptions<'pem', 'der'>): KeyPairSyncResult; + function generateKeyPairSync(type: 'ed25519', options: ED25519KeyPairOptions<'der', 'pem'>): KeyPairSyncResult; + function generateKeyPairSync(type: 'ed25519', options: ED25519KeyPairOptions<'der', 'der'>): KeyPairSyncResult; + function generateKeyPairSync(type: 'ed25519', options?: ED25519KeyPairKeyObjectOptions): KeyPairKeyObjectResult; + + function generateKeyPairSync(type: 'ed448', options: ED448KeyPairOptions<'pem', 'pem'>): KeyPairSyncResult; + function generateKeyPairSync(type: 'ed448', options: ED448KeyPairOptions<'pem', 'der'>): KeyPairSyncResult; + function generateKeyPairSync(type: 'ed448', options: ED448KeyPairOptions<'der', 'pem'>): KeyPairSyncResult; + function generateKeyPairSync(type: 'ed448', options: ED448KeyPairOptions<'der', 'der'>): KeyPairSyncResult; + function generateKeyPairSync(type: 'ed448', options?: ED448KeyPairKeyObjectOptions): KeyPairKeyObjectResult; + + function generateKeyPairSync(type: 'x25519', options: X25519KeyPairOptions<'pem', 'pem'>): KeyPairSyncResult; + function generateKeyPairSync(type: 'x25519', options: X25519KeyPairOptions<'pem', 'der'>): KeyPairSyncResult; + function generateKeyPairSync(type: 'x25519', options: X25519KeyPairOptions<'der', 'pem'>): KeyPairSyncResult; + function generateKeyPairSync(type: 'x25519', options: X25519KeyPairOptions<'der', 'der'>): KeyPairSyncResult; + function generateKeyPairSync(type: 'x25519', options?: X25519KeyPairKeyObjectOptions): KeyPairKeyObjectResult; + + function generateKeyPairSync(type: 'x448', options: X448KeyPairOptions<'pem', 'pem'>): KeyPairSyncResult; + function generateKeyPairSync(type: 'x448', options: X448KeyPairOptions<'pem', 'der'>): KeyPairSyncResult; + function generateKeyPairSync(type: 'x448', options: X448KeyPairOptions<'der', 'pem'>): KeyPairSyncResult; + function generateKeyPairSync(type: 'x448', options: X448KeyPairOptions<'der', 'der'>): KeyPairSyncResult; + function generateKeyPairSync(type: 'x448', options?: X448KeyPairKeyObjectOptions): KeyPairKeyObjectResult; + function generateKeyPair(type: 'rsa', options: RSAKeyPairOptions<'pem', 'pem'>, callback: (err: Error | null, publicKey: string, privateKey: string) => void): void; function generateKeyPair(type: 'rsa', options: RSAKeyPairOptions<'pem', 'der'>, callback: (err: Error | null, publicKey: string, privateKey: Buffer) => void): void; function generateKeyPair(type: 'rsa', options: RSAKeyPairOptions<'der', 'pem'>, callback: (err: Error | null, publicKey: Buffer, privateKey: string) => void): void; @@ -569,6 +675,30 @@ declare module "crypto" { function generateKeyPair(type: 'ec', options: ECKeyPairOptions<'der', 'der'>, callback: (err: Error | null, publicKey: Buffer, privateKey: Buffer) => void): void; function generateKeyPair(type: 'ec', options: ECKeyPairKeyObjectOptions, callback: (err: Error | null, publicKey: KeyObject, privateKey: KeyObject) => void): void; + function generateKeyPair(type: 'ed25519', options: ED25519KeyPairOptions<'pem', 'pem'>, callback: (err: Error | null, publicKey: string, privateKey: string) => void): void; + function generateKeyPair(type: 'ed25519', options: ED25519KeyPairOptions<'pem', 'der'>, callback: (err: Error | null, publicKey: string, privateKey: Buffer) => void): void; + function generateKeyPair(type: 'ed25519', options: ED25519KeyPairOptions<'der', 'pem'>, callback: (err: Error | null, publicKey: Buffer, privateKey: string) => void): void; + function generateKeyPair(type: 'ed25519', options: ED25519KeyPairOptions<'der', 'der'>, callback: (err: Error | null, publicKey: Buffer, privateKey: Buffer) => void): void; + function generateKeyPair(type: 'ed25519', options: ED25519KeyPairKeyObjectOptions | undefined, callback: (err: Error | null, publicKey: KeyObject, privateKey: KeyObject) => void): void; + + function generateKeyPair(type: 'ed448', options: ED448KeyPairOptions<'pem', 'pem'>, callback: (err: Error | null, publicKey: string, privateKey: string) => void): void; + function generateKeyPair(type: 'ed448', options: ED448KeyPairOptions<'pem', 'der'>, callback: (err: Error | null, publicKey: string, privateKey: Buffer) => void): void; + function generateKeyPair(type: 'ed448', options: ED448KeyPairOptions<'der', 'pem'>, callback: (err: Error | null, publicKey: Buffer, privateKey: string) => void): void; + function generateKeyPair(type: 'ed448', options: ED448KeyPairOptions<'der', 'der'>, callback: (err: Error | null, publicKey: Buffer, privateKey: Buffer) => void): void; + function generateKeyPair(type: 'ed448', options: ED448KeyPairKeyObjectOptions | undefined, callback: (err: Error | null, publicKey: KeyObject, privateKey: KeyObject) => void): void; + + function generateKeyPair(type: 'x25519', options: X25519KeyPairOptions<'pem', 'pem'>, callback: (err: Error | null, publicKey: string, privateKey: string) => void): void; + function generateKeyPair(type: 'x25519', options: X25519KeyPairOptions<'pem', 'der'>, callback: (err: Error | null, publicKey: string, privateKey: Buffer) => void): void; + function generateKeyPair(type: 'x25519', options: X25519KeyPairOptions<'der', 'pem'>, callback: (err: Error | null, publicKey: Buffer, privateKey: string) => void): void; + function generateKeyPair(type: 'x25519', options: X25519KeyPairOptions<'der', 'der'>, callback: (err: Error | null, publicKey: Buffer, privateKey: Buffer) => void): void; + function generateKeyPair(type: 'x25519', options: X25519KeyPairKeyObjectOptions | undefined, callback: (err: Error | null, publicKey: KeyObject, privateKey: KeyObject) => void): void; + + function generateKeyPair(type: 'x448', options: X448KeyPairOptions<'pem', 'pem'>, callback: (err: Error | null, publicKey: string, privateKey: string) => void): void; + function generateKeyPair(type: 'x448', options: X448KeyPairOptions<'pem', 'der'>, callback: (err: Error | null, publicKey: string, privateKey: Buffer) => void): void; + function generateKeyPair(type: 'x448', options: X448KeyPairOptions<'der', 'pem'>, callback: (err: Error | null, publicKey: Buffer, privateKey: string) => void): void; + function generateKeyPair(type: 'x448', options: X448KeyPairOptions<'der', 'der'>, callback: (err: Error | null, publicKey: Buffer, privateKey: Buffer) => void): void; + function generateKeyPair(type: 'x448', options: X448KeyPairKeyObjectOptions | undefined, callback: (err: Error | null, publicKey: KeyObject, privateKey: KeyObject) => void): void; + namespace generateKeyPair { function __promisify__(type: "rsa", options: RSAKeyPairOptions<'pem', 'pem'>): Promise<{ publicKey: string, privateKey: string }>; function __promisify__(type: "rsa", options: RSAKeyPairOptions<'pem', 'der'>): Promise<{ publicKey: string, privateKey: Buffer }>; @@ -587,6 +717,30 @@ declare module "crypto" { function __promisify__(type: "ec", options: ECKeyPairOptions<'der', 'pem'>): Promise<{ publicKey: Buffer, privateKey: string }>; function __promisify__(type: "ec", options: ECKeyPairOptions<'der', 'der'>): Promise<{ publicKey: Buffer, privateKey: Buffer }>; function __promisify__(type: "ec", options: ECKeyPairKeyObjectOptions): Promise; + + function __promisify__(type: "ed25519", options: ED25519KeyPairOptions<'pem', 'pem'>): Promise<{ publicKey: string, privateKey: string }>; + function __promisify__(type: "ed25519", options: ED25519KeyPairOptions<'pem', 'der'>): Promise<{ publicKey: string, privateKey: Buffer }>; + function __promisify__(type: "ed25519", options: ED25519KeyPairOptions<'der', 'pem'>): Promise<{ publicKey: Buffer, privateKey: string }>; + function __promisify__(type: "ed25519", options: ED25519KeyPairOptions<'der', 'der'>): Promise<{ publicKey: Buffer, privateKey: Buffer }>; + function __promisify__(type: "ed25519", options?: ED25519KeyPairKeyObjectOptions): Promise; + + function __promisify__(type: "ed448", options: ED448KeyPairOptions<'pem', 'pem'>): Promise<{ publicKey: string, privateKey: string }>; + function __promisify__(type: "ed448", options: ED448KeyPairOptions<'pem', 'der'>): Promise<{ publicKey: string, privateKey: Buffer }>; + function __promisify__(type: "ed448", options: ED448KeyPairOptions<'der', 'pem'>): Promise<{ publicKey: Buffer, privateKey: string }>; + function __promisify__(type: "ed448", options: ED448KeyPairOptions<'der', 'der'>): Promise<{ publicKey: Buffer, privateKey: Buffer }>; + function __promisify__(type: "ed448", options?: ED448KeyPairKeyObjectOptions): Promise; + + function __promisify__(type: "x25519", options: X25519KeyPairOptions<'pem', 'pem'>): Promise<{ publicKey: string, privateKey: string }>; + function __promisify__(type: "x25519", options: X25519KeyPairOptions<'pem', 'der'>): Promise<{ publicKey: string, privateKey: Buffer }>; + function __promisify__(type: "x25519", options: X25519KeyPairOptions<'der', 'pem'>): Promise<{ publicKey: Buffer, privateKey: string }>; + function __promisify__(type: "x25519", options: X25519KeyPairOptions<'der', 'der'>): Promise<{ publicKey: Buffer, privateKey: Buffer }>; + function __promisify__(type: "x25519", options?: X25519KeyPairKeyObjectOptions): Promise; + + function __promisify__(type: "x448", options: X448KeyPairOptions<'pem', 'pem'>): Promise<{ publicKey: string, privateKey: string }>; + function __promisify__(type: "x448", options: X448KeyPairOptions<'pem', 'der'>): Promise<{ publicKey: string, privateKey: Buffer }>; + function __promisify__(type: "x448", options: X448KeyPairOptions<'der', 'pem'>): Promise<{ publicKey: Buffer, privateKey: string }>; + function __promisify__(type: "x448", options: X448KeyPairOptions<'der', 'der'>): Promise<{ publicKey: Buffer, privateKey: Buffer }>; + function __promisify__(type: "x448", options?: X448KeyPairKeyObjectOptions): Promise; } /** @@ -597,10 +751,7 @@ declare module "crypto" { * If `key` is not a [`KeyObject`][], this function behaves as if `key` had been * passed to [`crypto.createPrivateKey()`][]. */ - function sign(algorithm: string | null | undefined, data: NodeJS.ArrayBufferView, key: KeyLike | SignPrivateKeyInput): Buffer; - - interface VerifyKeyWithOptions extends KeyObject, SigningOptions { - } + function sign(algorithm: string | null | undefined, data: NodeJS.ArrayBufferView, key: KeyLike | SignKeyObjectInput | SignPrivateKeyInput): Buffer; /** * Calculates and returns the signature for `data` using the given private key and @@ -610,5 +761,15 @@ declare module "crypto" { * If `key` is not a [`KeyObject`][], this function behaves as if `key` had been * passed to [`crypto.createPublicKey()`][]. */ - function verify(algorithm: string | null | undefined, data: NodeJS.ArrayBufferView, key: KeyLike | VerifyKeyWithOptions, signature: NodeJS.ArrayBufferView): Buffer; + function verify(algorithm: string | null | undefined, data: NodeJS.ArrayBufferView, key: KeyLike | VerifyKeyObjectInput | VerifyPublicKeyInput, signature: NodeJS.ArrayBufferView): boolean; + + /** + * Computes the Diffie-Hellman secret based on a privateKey and a publicKey. + * Both keys must have the same asymmetricKeyType, which must be one of + * 'dh' (for Diffie-Hellman), 'ec' (for ECDH), 'x448', or 'x25519' (for ECDH-ES). + */ + function diffieHellman(options: { + privateKey: KeyObject; + publicKey: KeyObject + }): Buffer; } diff --git a/node_modules/@types/node/dgram.d.ts b/node_modules/@types/node/dgram.d.ts index f04e9a2..73f2aa7 100644 --- a/node_modules/@types/node/dgram.d.ts +++ b/node_modules/@types/node/dgram.d.ts @@ -50,9 +50,9 @@ declare module "dgram" { getSendBufferSize(): number; ref(): this; remoteAddress(): AddressInfo; - send(msg: string | Uint8Array | any[], port?: number, address?: string, callback?: (error: Error | null, bytes: number) => void): void; - send(msg: string | Uint8Array | any[], port?: number, callback?: (error: Error | null, bytes: number) => void): void; - send(msg: string | Uint8Array | any[], callback?: (error: Error | null, bytes: number) => void): void; + send(msg: string | Uint8Array | ReadonlyArray, port?: number, address?: string, callback?: (error: Error | null, bytes: number) => void): void; + send(msg: string | Uint8Array | ReadonlyArray, port?: number, callback?: (error: Error | null, bytes: number) => void): void; + send(msg: string | Uint8Array | ReadonlyArray, callback?: (error: Error | null, bytes: number) => void): void; send(msg: string | Uint8Array, offset: number, length: number, port?: number, address?: string, callback?: (error: Error | null, bytes: number) => void): void; send(msg: string | Uint8Array, offset: number, length: number, port?: number, callback?: (error: Error | null, bytes: number) => void): void; send(msg: string | Uint8Array, offset: number, length: number, callback?: (error: Error | null, bytes: number) => void): void; @@ -64,6 +64,29 @@ declare module "dgram" { setSendBufferSize(size: number): void; setTTL(ttl: number): void; unref(): this; + /** + * Tells the kernel to join a source-specific multicast channel at the given + * `sourceAddress` and `groupAddress`, using the `multicastInterface` with the + * `IP_ADD_SOURCE_MEMBERSHIP` socket option. + * If the `multicastInterface` argument + * is not specified, the operating system will choose one interface and will add + * membership to it. + * To add membership to every available interface, call + * `socket.addSourceSpecificMembership()` multiple times, once per interface. + */ + addSourceSpecificMembership(sourceAddress: string, groupAddress: string, multicastInterface?: string): void; + + /** + * Instructs the kernel to leave a source-specific multicast channel at the given + * `sourceAddress` and `groupAddress` using the `IP_DROP_SOURCE_MEMBERSHIP` + * socket option. This method is automatically called by the kernel when the + * socket is closed or the process terminates, so most apps will never have + * reason to call this. + * + * If `multicastInterface` is not specified, the operating system will attempt to + * drop membership on all valid interfaces. + */ + dropSourceSpecificMembership(sourceAddress: string, groupAddress: string, multicastInterface?: string): void; /** * events.EventEmitter diff --git a/node_modules/@types/node/dns.d.ts b/node_modules/@types/node/dns.d.ts index d2b0505..8ce8864 100644 --- a/node_modules/@types/node/dns.d.ts +++ b/node_modules/@types/node/dns.d.ts @@ -2,6 +2,11 @@ declare module "dns" { // Supported getaddrinfo flags. const ADDRCONFIG: number; const V4MAPPED: number; + /** + * If `dns.V4MAPPED` is specified, return resolved IPv6 addresses as + * well as IPv4 mapped IPv6 addresses. + */ + const ALL: number; interface LookupOptions { family?: number; @@ -55,7 +60,7 @@ declare module "dns" { ttl: number; } - /** @deprecated Use AnyARecord or AnyAaaaRecord instead. */ + /** @deprecated Use `AnyARecord` or `AnyAaaaRecord` instead. */ type AnyRecordWithTtl = AnyARecord | AnyAaaaRecord; interface AnyARecord extends RecordWithTtl { diff --git a/node_modules/@types/node/domain.d.ts b/node_modules/@types/node/domain.d.ts index 45e388c..63dcc9b 100644 --- a/node_modules/@types/node/domain.d.ts +++ b/node_modules/@types/node/domain.d.ts @@ -1,13 +1,21 @@ declare module "domain" { - import * as events from "events"; + import { EventEmitter } from "events"; - class Domain extends events.EventEmitter implements NodeJS.Domain { - run(fn: (...args: any[]) => T, ...args: any[]): T; - add(emitter: events.EventEmitter | NodeJS.Timer): void; - remove(emitter: events.EventEmitter | NodeJS.Timer): void; - bind(cb: T): T; - intercept(cb: T): T; - members: Array; + global { + namespace NodeJS { + interface Domain extends EventEmitter { + run(fn: (...args: any[]) => T, ...args: any[]): T; + add(emitter: EventEmitter | Timer): void; + remove(emitter: EventEmitter | Timer): void; + bind(cb: T): T; + intercept(cb: T): T; + } + } + } + + interface Domain extends NodeJS.Domain {} + class Domain extends EventEmitter { + members: Array; enter(): void; exit(): void; } diff --git a/node_modules/@types/node/events.d.ts b/node_modules/@types/node/events.d.ts index 03f5b90..c7399f1 100644 --- a/node_modules/@types/node/events.d.ts +++ b/node_modules/@types/node/events.d.ts @@ -1,5 +1,10 @@ declare module "events" { - class internal extends NodeJS.EventEmitter { } + interface EventEmitterOptions { + /** + * Enables automatic capturing of promise rejection. + */ + captureRejections?: boolean; + } interface NodeEventTarget { once(event: string | symbol, listener: (...args: any[]) => void): this; @@ -9,31 +14,70 @@ declare module "events" { addEventListener(event: string, listener: (...args: any[]) => void, opts?: { once: boolean }): any; } - namespace internal { + namespace EventEmitter { function once(emitter: NodeEventTarget, event: string | symbol): Promise; function once(emitter: DOMEventTarget, event: string): Promise; - class EventEmitter extends internal { + function on(emitter: EventEmitter, event: string): AsyncIterableIterator; + const captureRejectionSymbol: unique symbol; + + /** + * This symbol shall be used to install a listener for only monitoring `'error'` + * events. Listeners installed using this symbol are called before the regular + * `'error'` listeners are called. + * + * Installing a listener using this symbol does not change the behavior once an + * `'error'` event is emitted, therefore the process will still crash if no + * regular `'error'` listener is installed. + */ + const errorMonitor: unique symbol; + /** + * Sets or gets the default captureRejection value for all emitters. + */ + let captureRejections: boolean; + + interface EventEmitter extends NodeJS.EventEmitter { + } + + class EventEmitter { + constructor(options?: EventEmitterOptions); /** @deprecated since v4.0.0 */ static listenerCount(emitter: EventEmitter, event: string | symbol): number; static defaultMaxListeners: number; - - addListener(event: string | symbol, listener: (...args: any[]) => void): this; - on(event: string | symbol, listener: (...args: any[]) => void): this; - once(event: string | symbol, listener: (...args: any[]) => void): this; - prependListener(event: string | symbol, listener: (...args: any[]) => void): this; - prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this; - removeListener(event: string | symbol, listener: (...args: any[]) => void): this; - off(event: string | symbol, listener: (...args: any[]) => void): this; - removeAllListeners(event?: string | symbol): this; - setMaxListeners(n: number): this; - getMaxListeners(): number; - listeners(event: string | symbol): Function[]; - rawListeners(event: string | symbol): Function[]; - emit(event: string | symbol, ...args: any[]): boolean; - eventNames(): Array; - listenerCount(type: string | symbol): number; + /** + * This symbol shall be used to install a listener for only monitoring `'error'` + * events. Listeners installed using this symbol are called before the regular + * `'error'` listeners are called. + * + * Installing a listener using this symbol does not change the behavior once an + * `'error'` event is emitted, therefore the process will still crash if no + * regular `'error'` listener is installed. + */ + static readonly errorMonitor: unique symbol; } } - export = internal; + global { + namespace NodeJS { + interface EventEmitter { + addListener(event: string | symbol, listener: (...args: any[]) => void): this; + on(event: string | symbol, listener: (...args: any[]) => void): this; + once(event: string | symbol, listener: (...args: any[]) => void): this; + removeListener(event: string | symbol, listener: (...args: any[]) => void): this; + off(event: string | symbol, listener: (...args: any[]) => void): this; + removeAllListeners(event?: string | symbol): this; + setMaxListeners(n: number): this; + getMaxListeners(): number; + listeners(event: string | symbol): Function[]; + rawListeners(event: string | symbol): Function[]; + emit(event: string | symbol, ...args: any[]): boolean; + listenerCount(event: string | symbol): number; + // Added in Node 6... + prependListener(event: string | symbol, listener: (...args: any[]) => void): this; + prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this; + eventNames(): Array; + } + } + } + + export = EventEmitter; } diff --git a/node_modules/@types/node/fs.d.ts b/node_modules/@types/node/fs.d.ts index 8c57f0c..c971021 100644 --- a/node_modules/@types/node/fs.d.ts +++ b/node_modules/@types/node/fs.d.ts @@ -2,15 +2,27 @@ declare module "fs" { import * as stream from "stream"; import * as events from "events"; import { URL } from "url"; + import * as promises from 'fs/promises'; + export { promises }; /** * Valid types for path values in "fs". */ - type PathLike = string | Buffer | URL; + export type PathLike = string | Buffer | URL; - type NoParamCallback = (err: NodeJS.ErrnoException | null) => void; + export type NoParamCallback = (err: NodeJS.ErrnoException | null) => void; - interface StatsBase { + export type BufferEncodingOption = 'buffer' | { encoding: 'buffer' }; + + export interface BaseEncodingOptions { + encoding?: BufferEncoding | null; + } + + export type OpenMode = number | string; + + export type Mode = number | string; + + export interface StatsBase { isFile(): boolean; isDirectory(): boolean; isBlockDevice(): boolean; @@ -19,33 +31,33 @@ declare module "fs" { isFIFO(): boolean; isSocket(): boolean; - dev: number; - ino: number; - mode: number; - nlink: number; - uid: number; - gid: number; - rdev: number; - size: number; - blksize: number; - blocks: number; - atimeMs: number; - mtimeMs: number; - ctimeMs: number; - birthtimeMs: number; + dev: T; + ino: T; + mode: T; + nlink: T; + uid: T; + gid: T; + rdev: T; + size: T; + blksize: T; + blocks: T; + atimeMs: T; + mtimeMs: T; + ctimeMs: T; + birthtimeMs: T; atime: Date; mtime: Date; ctime: Date; birthtime: Date; } - interface Stats extends StatsBase { + export interface Stats extends StatsBase { } - class Stats { + export class Stats { } - class Dirent { + export class Dirent { isFile(): boolean; isDirectory(): boolean; isBlockDevice(): boolean; @@ -59,7 +71,7 @@ declare module "fs" { /** * A class representing a directory stream. */ - class Dir { + export class Dir { readonly path: string; /** @@ -96,7 +108,7 @@ declare module "fs" { readSync(): Dirent; } - interface FSWatcher extends events.EventEmitter { + export interface FSWatcher extends events.EventEmitter { close(): void; /** @@ -107,84 +119,158 @@ declare module "fs" { addListener(event: string, listener: (...args: any[]) => void): this; addListener(event: "change", listener: (eventType: string, filename: string | Buffer) => void): this; addListener(event: "error", listener: (error: Error) => void): this; + addListener(event: "close", listener: () => void): this; on(event: string, listener: (...args: any[]) => void): this; on(event: "change", listener: (eventType: string, filename: string | Buffer) => void): this; on(event: "error", listener: (error: Error) => void): this; + on(event: "close", listener: () => void): this; once(event: string, listener: (...args: any[]) => void): this; once(event: "change", listener: (eventType: string, filename: string | Buffer) => void): this; once(event: "error", listener: (error: Error) => void): this; + once(event: "close", listener: () => void): this; prependListener(event: string, listener: (...args: any[]) => void): this; prependListener(event: "change", listener: (eventType: string, filename: string | Buffer) => void): this; prependListener(event: "error", listener: (error: Error) => void): this; + prependListener(event: "close", listener: () => void): this; prependOnceListener(event: string, listener: (...args: any[]) => void): this; prependOnceListener(event: "change", listener: (eventType: string, filename: string | Buffer) => void): this; prependOnceListener(event: "error", listener: (error: Error) => void): this; + prependOnceListener(event: "close", listener: () => void): this; } - class ReadStream extends stream.Readable { + export class ReadStream extends stream.Readable { close(): void; bytesRead: number; path: string | Buffer; + pending: boolean; /** * events.EventEmitter * 1. open * 2. close + * 3. ready */ - addListener(event: string, listener: (...args: any[]) => void): this; - addListener(event: "open", listener: (fd: number) => void): this; addListener(event: "close", listener: () => void): this; + addListener(event: "data", listener: (chunk: Buffer | string) => void): this; + addListener(event: "end", listener: () => void): this; + addListener(event: "error", listener: (err: Error) => void): this; + addListener(event: "open", listener: (fd: number) => void): this; + addListener(event: "pause", listener: () => void): this; + addListener(event: "readable", listener: () => void): this; + addListener(event: "ready", listener: () => void): this; + addListener(event: "resume", listener: () => void): this; + addListener(event: string | symbol, listener: (...args: any[]) => void): this; - on(event: string, listener: (...args: any[]) => void): this; - on(event: "open", listener: (fd: number) => void): this; on(event: "close", listener: () => void): this; + on(event: "data", listener: (chunk: Buffer | string) => void): this; + on(event: "end", listener: () => void): this; + on(event: "error", listener: (err: Error) => void): this; + on(event: "open", listener: (fd: number) => void): this; + on(event: "pause", listener: () => void): this; + on(event: "readable", listener: () => void): this; + on(event: "ready", listener: () => void): this; + on(event: "resume", listener: () => void): this; + on(event: string | symbol, listener: (...args: any[]) => void): this; - once(event: string, listener: (...args: any[]) => void): this; - once(event: "open", listener: (fd: number) => void): this; once(event: "close", listener: () => void): this; + once(event: "data", listener: (chunk: Buffer | string) => void): this; + once(event: "end", listener: () => void): this; + once(event: "error", listener: (err: Error) => void): this; + once(event: "open", listener: (fd: number) => void): this; + once(event: "pause", listener: () => void): this; + once(event: "readable", listener: () => void): this; + once(event: "ready", listener: () => void): this; + once(event: "resume", listener: () => void): this; + once(event: string | symbol, listener: (...args: any[]) => void): this; - prependListener(event: string, listener: (...args: any[]) => void): this; - prependListener(event: "open", listener: (fd: number) => void): this; prependListener(event: "close", listener: () => void): this; + prependListener(event: "data", listener: (chunk: Buffer | string) => void): this; + prependListener(event: "end", listener: () => void): this; + prependListener(event: "error", listener: (err: Error) => void): this; + prependListener(event: "open", listener: (fd: number) => void): this; + prependListener(event: "pause", listener: () => void): this; + prependListener(event: "readable", listener: () => void): this; + prependListener(event: "ready", listener: () => void): this; + prependListener(event: "resume", listener: () => void): this; + prependListener(event: string | symbol, listener: (...args: any[]) => void): this; - prependOnceListener(event: string, listener: (...args: any[]) => void): this; - prependOnceListener(event: "open", listener: (fd: number) => void): this; prependOnceListener(event: "close", listener: () => void): this; + prependOnceListener(event: "data", listener: (chunk: Buffer | string) => void): this; + prependOnceListener(event: "end", listener: () => void): this; + prependOnceListener(event: "error", listener: (err: Error) => void): this; + prependOnceListener(event: "open", listener: (fd: number) => void): this; + prependOnceListener(event: "pause", listener: () => void): this; + prependOnceListener(event: "readable", listener: () => void): this; + prependOnceListener(event: "ready", listener: () => void): this; + prependOnceListener(event: "resume", listener: () => void): this; + prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this; } - class WriteStream extends stream.Writable { + export class WriteStream extends stream.Writable { close(): void; bytesWritten: number; path: string | Buffer; + pending: boolean; /** * events.EventEmitter * 1. open * 2. close + * 3. ready */ - addListener(event: string, listener: (...args: any[]) => void): this; - addListener(event: "open", listener: (fd: number) => void): this; addListener(event: "close", listener: () => void): this; + addListener(event: "drain", listener: () => void): this; + addListener(event: "error", listener: (err: Error) => void): this; + addListener(event: "finish", listener: () => void): this; + addListener(event: "open", listener: (fd: number) => void): this; + addListener(event: "pipe", listener: (src: stream.Readable) => void): this; + addListener(event: "ready", listener: () => void): this; + addListener(event: "unpipe", listener: (src: stream.Readable) => void): this; + addListener(event: string | symbol, listener: (...args: any[]) => void): this; - on(event: string, listener: (...args: any[]) => void): this; - on(event: "open", listener: (fd: number) => void): this; on(event: "close", listener: () => void): this; + on(event: "drain", listener: () => void): this; + on(event: "error", listener: (err: Error) => void): this; + on(event: "finish", listener: () => void): this; + on(event: "open", listener: (fd: number) => void): this; + on(event: "pipe", listener: (src: stream.Readable) => void): this; + on(event: "ready", listener: () => void): this; + on(event: "unpipe", listener: (src: stream.Readable) => void): this; + on(event: string | symbol, listener: (...args: any[]) => void): this; - once(event: string, listener: (...args: any[]) => void): this; - once(event: "open", listener: (fd: number) => void): this; once(event: "close", listener: () => void): this; + once(event: "drain", listener: () => void): this; + once(event: "error", listener: (err: Error) => void): this; + once(event: "finish", listener: () => void): this; + once(event: "open", listener: (fd: number) => void): this; + once(event: "pipe", listener: (src: stream.Readable) => void): this; + once(event: "ready", listener: () => void): this; + once(event: "unpipe", listener: (src: stream.Readable) => void): this; + once(event: string | symbol, listener: (...args: any[]) => void): this; - prependListener(event: string, listener: (...args: any[]) => void): this; - prependListener(event: "open", listener: (fd: number) => void): this; prependListener(event: "close", listener: () => void): this; + prependListener(event: "drain", listener: () => void): this; + prependListener(event: "error", listener: (err: Error) => void): this; + prependListener(event: "finish", listener: () => void): this; + prependListener(event: "open", listener: (fd: number) => void): this; + prependListener(event: "pipe", listener: (src: stream.Readable) => void): this; + prependListener(event: "ready", listener: () => void): this; + prependListener(event: "unpipe", listener: (src: stream.Readable) => void): this; + prependListener(event: string | symbol, listener: (...args: any[]) => void): this; - prependOnceListener(event: string, listener: (...args: any[]) => void): this; - prependOnceListener(event: "open", listener: (fd: number) => void): this; prependOnceListener(event: "close", listener: () => void): this; + prependOnceListener(event: "drain", listener: () => void): this; + prependOnceListener(event: "error", listener: (err: Error) => void): this; + prependOnceListener(event: "finish", listener: () => void): this; + prependOnceListener(event: "open", listener: (fd: number) => void): this; + prependOnceListener(event: "pipe", listener: (src: stream.Readable) => void): this; + prependOnceListener(event: "ready", listener: () => void): this; + prependOnceListener(event: "unpipe", listener: (src: stream.Readable) => void): this; + prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this; } /** @@ -194,10 +280,10 @@ declare module "fs" { * @param newPath A path to a file. If a URL is provided, it must use the `file:` protocol. * URL support is _experimental_. */ - function rename(oldPath: PathLike, newPath: PathLike, callback: NoParamCallback): void; + export function rename(oldPath: PathLike, newPath: PathLike, callback: NoParamCallback): void; // NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime. - namespace rename { + export namespace rename { /** * Asynchronous rename(2) - Change the name or location of a file or directory. * @param oldPath A path to a file. If a URL is provided, it must use the `file:` protocol. @@ -215,24 +301,24 @@ declare module "fs" { * @param newPath A path to a file. If a URL is provided, it must use the `file:` protocol. * URL support is _experimental_. */ - function renameSync(oldPath: PathLike, newPath: PathLike): void; + export function renameSync(oldPath: PathLike, newPath: PathLike): void; /** * Asynchronous truncate(2) - Truncate a file to a specified length. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * @param len If not specified, defaults to `0`. */ - function truncate(path: PathLike, len: number | undefined | null, callback: NoParamCallback): void; + export function truncate(path: PathLike, len: number | undefined | null, callback: NoParamCallback): void; /** * Asynchronous truncate(2) - Truncate a file to a specified length. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * URL support is _experimental_. */ - function truncate(path: PathLike, callback: NoParamCallback): void; + export function truncate(path: PathLike, callback: NoParamCallback): void; // NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime. - namespace truncate { + export namespace truncate { /** * Asynchronous truncate(2) - Truncate a file to a specified length. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. @@ -246,23 +332,23 @@ declare module "fs" { * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * @param len If not specified, defaults to `0`. */ - function truncateSync(path: PathLike, len?: number | null): void; + export function truncateSync(path: PathLike, len?: number | null): void; /** * Asynchronous ftruncate(2) - Truncate a file to a specified length. * @param fd A file descriptor. * @param len If not specified, defaults to `0`. */ - function ftruncate(fd: number, len: number | undefined | null, callback: NoParamCallback): void; + export function ftruncate(fd: number, len: number | undefined | null, callback: NoParamCallback): void; /** * Asynchronous ftruncate(2) - Truncate a file to a specified length. * @param fd A file descriptor. */ - function ftruncate(fd: number, callback: NoParamCallback): void; + export function ftruncate(fd: number, callback: NoParamCallback): void; // NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime. - namespace ftruncate { + export namespace ftruncate { /** * Asynchronous ftruncate(2) - Truncate a file to a specified length. * @param fd A file descriptor. @@ -276,16 +362,16 @@ declare module "fs" { * @param fd A file descriptor. * @param len If not specified, defaults to `0`. */ - function ftruncateSync(fd: number, len?: number | null): void; + export function ftruncateSync(fd: number, len?: number | null): void; /** * Asynchronous chown(2) - Change ownership of a file. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. */ - function chown(path: PathLike, uid: number, gid: number, callback: NoParamCallback): void; + export function chown(path: PathLike, uid: number, gid: number, callback: NoParamCallback): void; // NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime. - namespace chown { + export namespace chown { /** * Asynchronous chown(2) - Change ownership of a file. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. @@ -297,16 +383,16 @@ declare module "fs" { * Synchronous chown(2) - Change ownership of a file. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. */ - function chownSync(path: PathLike, uid: number, gid: number): void; + export function chownSync(path: PathLike, uid: number, gid: number): void; /** * Asynchronous fchown(2) - Change ownership of a file. * @param fd A file descriptor. */ - function fchown(fd: number, uid: number, gid: number, callback: NoParamCallback): void; + export function fchown(fd: number, uid: number, gid: number, callback: NoParamCallback): void; // NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime. - namespace fchown { + export namespace fchown { /** * Asynchronous fchown(2) - Change ownership of a file. * @param fd A file descriptor. @@ -318,16 +404,16 @@ declare module "fs" { * Synchronous fchown(2) - Change ownership of a file. * @param fd A file descriptor. */ - function fchownSync(fd: number, uid: number, gid: number): void; + export function fchownSync(fd: number, uid: number, gid: number): void; /** * Asynchronous lchown(2) - Change ownership of a file. Does not dereference symbolic links. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. */ - function lchown(path: PathLike, uid: number, gid: number, callback: NoParamCallback): void; + export function lchown(path: PathLike, uid: number, gid: number, callback: NoParamCallback): void; // NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime. - namespace lchown { + export namespace lchown { /** * Asynchronous lchown(2) - Change ownership of a file. Does not dereference symbolic links. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. @@ -339,23 +425,56 @@ declare module "fs" { * Synchronous lchown(2) - Change ownership of a file. Does not dereference symbolic links. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. */ - function lchownSync(path: PathLike, uid: number, gid: number): void; + export function lchownSync(path: PathLike, uid: number, gid: number): void; + + /** + * Changes the access and modification times of a file in the same way as `fs.utimes()`, + * with the difference that if the path refers to a symbolic link, then the link is not + * dereferenced: instead, the timestamps of the symbolic link itself are changed. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param atime The last access time. If a string is provided, it will be coerced to number. + * @param mtime The last modified time. If a string is provided, it will be coerced to number. + */ + export function lutimes(path: PathLike, atime: string | number | Date, mtime: string | number | Date, callback: NoParamCallback): void; + + // NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime. + export namespace lutimes { + /** + * Changes the access and modification times of a file in the same way as `fsPromises.utimes()`, + * with the difference that if the path refers to a symbolic link, then the link is not + * dereferenced: instead, the timestamps of the symbolic link itself are changed. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param atime The last access time. If a string is provided, it will be coerced to number. + * @param mtime The last modified time. If a string is provided, it will be coerced to number. + */ + function __promisify__(path: PathLike, atime: string | number | Date, mtime: string | number | Date): Promise; + } + + /** + * Change the file system timestamps of the symbolic link referenced by `path`. Returns `undefined`, + * or throws an exception when parameters are incorrect or the operation fails. + * This is the synchronous version of `fs.lutimes()`. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param atime The last access time. If a string is provided, it will be coerced to number. + * @param mtime The last modified time. If a string is provided, it will be coerced to number. + */ + export function lutimesSync(path: PathLike, atime: string | number | Date, mtime: string | number | Date): void; /** * Asynchronous chmod(2) - Change permissions of a file. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * @param mode A file mode. If a string is passed, it is parsed as an octal integer. */ - function chmod(path: PathLike, mode: string | number, callback: NoParamCallback): void; + export function chmod(path: PathLike, mode: Mode, callback: NoParamCallback): void; // NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime. - namespace chmod { + export namespace chmod { /** * Asynchronous chmod(2) - Change permissions of a file. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * @param mode A file mode. If a string is passed, it is parsed as an octal integer. */ - function __promisify__(path: PathLike, mode: string | number): Promise; + function __promisify__(path: PathLike, mode: Mode): Promise; } /** @@ -363,23 +482,23 @@ declare module "fs" { * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * @param mode A file mode. If a string is passed, it is parsed as an octal integer. */ - function chmodSync(path: PathLike, mode: string | number): void; + export function chmodSync(path: PathLike, mode: Mode): void; /** * Asynchronous fchmod(2) - Change permissions of a file. * @param fd A file descriptor. * @param mode A file mode. If a string is passed, it is parsed as an octal integer. */ - function fchmod(fd: number, mode: string | number, callback: NoParamCallback): void; + export function fchmod(fd: number, mode: Mode, callback: NoParamCallback): void; // NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime. - namespace fchmod { + export namespace fchmod { /** * Asynchronous fchmod(2) - Change permissions of a file. * @param fd A file descriptor. * @param mode A file mode. If a string is passed, it is parsed as an octal integer. */ - function __promisify__(fd: number, mode: string | number): Promise; + function __promisify__(fd: number, mode: Mode): Promise; } /** @@ -387,23 +506,23 @@ declare module "fs" { * @param fd A file descriptor. * @param mode A file mode. If a string is passed, it is parsed as an octal integer. */ - function fchmodSync(fd: number, mode: string | number): void; + export function fchmodSync(fd: number, mode: Mode): void; /** * Asynchronous lchmod(2) - Change permissions of a file. Does not dereference symbolic links. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * @param mode A file mode. If a string is passed, it is parsed as an octal integer. */ - function lchmod(path: PathLike, mode: string | number, callback: NoParamCallback): void; + export function lchmod(path: PathLike, mode: Mode, callback: NoParamCallback): void; // NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime. - namespace lchmod { + export namespace lchmod { /** * Asynchronous lchmod(2) - Change permissions of a file. Does not dereference symbolic links. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * @param mode A file mode. If a string is passed, it is parsed as an octal integer. */ - function __promisify__(path: PathLike, mode: string | number): Promise; + function __promisify__(path: PathLike, mode: Mode): Promise; } /** @@ -411,20 +530,24 @@ declare module "fs" { * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * @param mode A file mode. If a string is passed, it is parsed as an octal integer. */ - function lchmodSync(path: PathLike, mode: string | number): void; + export function lchmodSync(path: PathLike, mode: Mode): void; /** * Asynchronous stat(2) - Get file status. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. */ - function stat(path: PathLike, callback: (err: NodeJS.ErrnoException | null, stats: Stats) => void): void; + export function stat(path: PathLike, options: BigIntOptions, callback: (err: NodeJS.ErrnoException | null, stats: BigIntStats) => void): void; + export function stat(path: PathLike, options: StatOptions, callback: (err: NodeJS.ErrnoException | null, stats: Stats | BigIntStats) => void): void; + export function stat(path: PathLike, callback: (err: NodeJS.ErrnoException | null, stats: Stats) => void): void; // NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime. - namespace stat { + export namespace stat { /** * Asynchronous stat(2) - Get file status. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. */ + function __promisify__(path: PathLike, options: BigIntOptions): Promise; + function __promisify__(path: PathLike, options: StatOptions): Promise; function __promisify__(path: PathLike): Promise; } @@ -432,16 +555,18 @@ declare module "fs" { * Synchronous stat(2) - Get file status. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. */ - function statSync(path: PathLike): Stats; + export function statSync(path: PathLike, options: BigIntOptions): BigIntStats; + export function statSync(path: PathLike, options: StatOptions): Stats | BigIntStats; + export function statSync(path: PathLike): Stats; /** * Asynchronous fstat(2) - Get file status. * @param fd A file descriptor. */ - function fstat(fd: number, callback: (err: NodeJS.ErrnoException | null, stats: Stats) => void): void; + export function fstat(fd: number, callback: (err: NodeJS.ErrnoException | null, stats: Stats) => void): void; // NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime. - namespace fstat { + export namespace fstat { /** * Asynchronous fstat(2) - Get file status. * @param fd A file descriptor. @@ -453,16 +578,16 @@ declare module "fs" { * Synchronous fstat(2) - Get file status. * @param fd A file descriptor. */ - function fstatSync(fd: number): Stats; + export function fstatSync(fd: number): Stats; /** * Asynchronous lstat(2) - Get file status. Does not dereference symbolic links. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. */ - function lstat(path: PathLike, callback: (err: NodeJS.ErrnoException | null, stats: Stats) => void): void; + export function lstat(path: PathLike, callback: (err: NodeJS.ErrnoException | null, stats: Stats) => void): void; // NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime. - namespace lstat { + export namespace lstat { /** * Asynchronous lstat(2) - Get file status. Does not dereference symbolic links. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. @@ -474,17 +599,17 @@ declare module "fs" { * Synchronous lstat(2) - Get file status. Does not dereference symbolic links. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. */ - function lstatSync(path: PathLike): Stats; + export function lstatSync(path: PathLike): Stats; /** * Asynchronous link(2) - Create a new link (also known as a hard link) to an existing file. * @param existingPath A path to a file. If a URL is provided, it must use the `file:` protocol. * @param newPath A path to a file. If a URL is provided, it must use the `file:` protocol. */ - function link(existingPath: PathLike, newPath: PathLike, callback: NoParamCallback): void; + export function link(existingPath: PathLike, newPath: PathLike, callback: NoParamCallback): void; // NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime. - namespace link { + export namespace link { /** * Asynchronous link(2) - Create a new link (also known as a hard link) to an existing file. * @param existingPath A path to a file. If a URL is provided, it must use the `file:` protocol. @@ -498,7 +623,7 @@ declare module "fs" { * @param existingPath A path to a file. If a URL is provided, it must use the `file:` protocol. * @param newPath A path to a file. If a URL is provided, it must use the `file:` protocol. */ - function linkSync(existingPath: PathLike, newPath: PathLike): void; + export function linkSync(existingPath: PathLike, newPath: PathLike): void; /** * Asynchronous symlink(2) - Create a new symbolic link to an existing file. @@ -507,17 +632,17 @@ declare module "fs" { * @param type May be set to `'dir'`, `'file'`, or `'junction'` (default is `'file'`) and is only available on Windows (ignored on other platforms). * When using `'junction'`, the `target` argument will automatically be normalized to an absolute path. */ - function symlink(target: PathLike, path: PathLike, type: symlink.Type | undefined | null, callback: NoParamCallback): void; + export function symlink(target: PathLike, path: PathLike, type: symlink.Type | undefined | null, callback: NoParamCallback): void; /** * Asynchronous symlink(2) - Create a new symbolic link to an existing file. * @param target A path to an existing file. If a URL is provided, it must use the `file:` protocol. * @param path A path to the new symlink. If a URL is provided, it must use the `file:` protocol. */ - function symlink(target: PathLike, path: PathLike, callback: NoParamCallback): void; + export function symlink(target: PathLike, path: PathLike, callback: NoParamCallback): void; // NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime. - namespace symlink { + export namespace symlink { /** * Asynchronous symlink(2) - Create a new symbolic link to an existing file. * @param target A path to an existing file. If a URL is provided, it must use the `file:` protocol. @@ -537,16 +662,16 @@ declare module "fs" { * @param type May be set to `'dir'`, `'file'`, or `'junction'` (default is `'file'`) and is only available on Windows (ignored on other platforms). * When using `'junction'`, the `target` argument will automatically be normalized to an absolute path. */ - function symlinkSync(target: PathLike, path: PathLike, type?: symlink.Type | null): void; + export function symlinkSync(target: PathLike, path: PathLike, type?: symlink.Type | null): void; /** * Asynchronous readlink(2) - read value of a symbolic link. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. */ - function readlink( + export function readlink( path: PathLike, - options: { encoding?: BufferEncoding | null } | BufferEncoding | undefined | null, + options: BaseEncodingOptions | BufferEncoding | undefined | null, callback: (err: NodeJS.ErrnoException | null, linkString: string) => void ): void; @@ -555,43 +680,43 @@ declare module "fs" { * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. */ - function readlink(path: PathLike, options: { encoding: "buffer" } | "buffer", callback: (err: NodeJS.ErrnoException | null, linkString: Buffer) => void): void; + export function readlink(path: PathLike, options: BufferEncodingOption, callback: (err: NodeJS.ErrnoException | null, linkString: Buffer) => void): void; /** * Asynchronous readlink(2) - read value of a symbolic link. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. */ - function readlink(path: PathLike, options: { encoding?: string | null } | string | undefined | null, callback: (err: NodeJS.ErrnoException | null, linkString: string | Buffer) => void): void; + export function readlink(path: PathLike, options: BaseEncodingOptions | string | undefined | null, callback: (err: NodeJS.ErrnoException | null, linkString: string | Buffer) => void): void; /** * Asynchronous readlink(2) - read value of a symbolic link. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. */ - function readlink(path: PathLike, callback: (err: NodeJS.ErrnoException | null, linkString: string) => void): void; + export function readlink(path: PathLike, callback: (err: NodeJS.ErrnoException | null, linkString: string) => void): void; // NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime. - namespace readlink { + export namespace readlink { /** * Asynchronous readlink(2) - read value of a symbolic link. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. */ - function __promisify__(path: PathLike, options?: { encoding?: BufferEncoding | null } | BufferEncoding | null): Promise; + function __promisify__(path: PathLike, options?: BaseEncodingOptions | BufferEncoding | null): Promise; /** * Asynchronous readlink(2) - read value of a symbolic link. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. */ - function __promisify__(path: PathLike, options: { encoding: "buffer" } | "buffer"): Promise; + function __promisify__(path: PathLike, options: BufferEncodingOption): Promise; /** * Asynchronous readlink(2) - read value of a symbolic link. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. */ - function __promisify__(path: PathLike, options?: { encoding?: string | null } | string | null): Promise; + function __promisify__(path: PathLike, options?: BaseEncodingOptions | string | null): Promise; } /** @@ -599,30 +724,30 @@ declare module "fs" { * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. */ - function readlinkSync(path: PathLike, options?: { encoding?: BufferEncoding | null } | BufferEncoding | null): string; + export function readlinkSync(path: PathLike, options?: BaseEncodingOptions | BufferEncoding | null): string; /** * Synchronous readlink(2) - read value of a symbolic link. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. */ - function readlinkSync(path: PathLike, options: { encoding: "buffer" } | "buffer"): Buffer; + export function readlinkSync(path: PathLike, options: BufferEncodingOption): Buffer; /** * Synchronous readlink(2) - read value of a symbolic link. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. */ - function readlinkSync(path: PathLike, options?: { encoding?: string | null } | string | null): string | Buffer; + export function readlinkSync(path: PathLike, options?: BaseEncodingOptions | string | null): string | Buffer; /** * Asynchronous realpath(3) - return the canonicalized absolute pathname. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. */ - function realpath( + export function realpath( path: PathLike, - options: { encoding?: BufferEncoding | null } | BufferEncoding | undefined | null, + options: BaseEncodingOptions | BufferEncoding | undefined | null, callback: (err: NodeJS.ErrnoException | null, resolvedPath: string) => void ): void; @@ -631,51 +756,51 @@ declare module "fs" { * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. */ - function realpath(path: PathLike, options: { encoding: "buffer" } | "buffer", callback: (err: NodeJS.ErrnoException | null, resolvedPath: Buffer) => void): void; + export function realpath(path: PathLike, options: BufferEncodingOption, callback: (err: NodeJS.ErrnoException | null, resolvedPath: Buffer) => void): void; /** * Asynchronous realpath(3) - return the canonicalized absolute pathname. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. */ - function realpath(path: PathLike, options: { encoding?: string | null } | string | undefined | null, callback: (err: NodeJS.ErrnoException | null, resolvedPath: string | Buffer) => void): void; + export function realpath(path: PathLike, options: BaseEncodingOptions | string | undefined | null, callback: (err: NodeJS.ErrnoException | null, resolvedPath: string | Buffer) => void): void; /** * Asynchronous realpath(3) - return the canonicalized absolute pathname. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. */ - function realpath(path: PathLike, callback: (err: NodeJS.ErrnoException | null, resolvedPath: string) => void): void; + export function realpath(path: PathLike, callback: (err: NodeJS.ErrnoException | null, resolvedPath: string) => void): void; // NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime. - namespace realpath { + export namespace realpath { /** * Asynchronous realpath(3) - return the canonicalized absolute pathname. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. */ - function __promisify__(path: PathLike, options?: { encoding?: BufferEncoding | null } | BufferEncoding | null): Promise; + function __promisify__(path: PathLike, options?: BaseEncodingOptions | BufferEncoding | null): Promise; /** * Asynchronous realpath(3) - return the canonicalized absolute pathname. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. */ - function __promisify__(path: PathLike, options: { encoding: "buffer" } | "buffer"): Promise; + function __promisify__(path: PathLike, options: BufferEncodingOption): Promise; /** * Asynchronous realpath(3) - return the canonicalized absolute pathname. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. */ - function __promisify__(path: PathLike, options?: { encoding?: string | null } | string | null): Promise; + function __promisify__(path: PathLike, options?: BaseEncodingOptions | string | null): Promise; function native( path: PathLike, - options: { encoding?: BufferEncoding | null } | BufferEncoding | undefined | null, + options: BaseEncodingOptions | BufferEncoding | undefined | null, callback: (err: NodeJS.ErrnoException | null, resolvedPath: string) => void ): void; - function native(path: PathLike, options: { encoding: "buffer" } | "buffer", callback: (err: NodeJS.ErrnoException | null, resolvedPath: Buffer) => void): void; - function native(path: PathLike, options: { encoding?: string | null } | string | undefined | null, callback: (err: NodeJS.ErrnoException | null, resolvedPath: string | Buffer) => void): void; + function native(path: PathLike, options: BufferEncodingOption, callback: (err: NodeJS.ErrnoException | null, resolvedPath: Buffer) => void): void; + function native(path: PathLike, options: BaseEncodingOptions | string | undefined | null, callback: (err: NodeJS.ErrnoException | null, resolvedPath: string | Buffer) => void): void; function native(path: PathLike, callback: (err: NodeJS.ErrnoException | null, resolvedPath: string) => void): void; } @@ -684,36 +809,36 @@ declare module "fs" { * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. */ - function realpathSync(path: PathLike, options?: { encoding?: BufferEncoding | null } | BufferEncoding | null): string; + export function realpathSync(path: PathLike, options?: BaseEncodingOptions | BufferEncoding | null): string; /** * Synchronous realpath(3) - return the canonicalized absolute pathname. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. */ - function realpathSync(path: PathLike, options: { encoding: "buffer" } | "buffer"): Buffer; + export function realpathSync(path: PathLike, options: BufferEncodingOption): Buffer; /** * Synchronous realpath(3) - return the canonicalized absolute pathname. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. */ - function realpathSync(path: PathLike, options?: { encoding?: string | null } | string | null): string | Buffer; + export function realpathSync(path: PathLike, options?: BaseEncodingOptions | string | null): string | Buffer; - namespace realpathSync { - function native(path: PathLike, options?: { encoding?: BufferEncoding | null } | BufferEncoding | null): string; - function native(path: PathLike, options: { encoding: "buffer" } | "buffer"): Buffer; - function native(path: PathLike, options?: { encoding?: string | null } | string | null): string | Buffer; + export namespace realpathSync { + function native(path: PathLike, options?: BaseEncodingOptions | BufferEncoding | null): string; + function native(path: PathLike, options: BufferEncodingOption): Buffer; + function native(path: PathLike, options?: BaseEncodingOptions | string | null): string | Buffer; } /** * Asynchronous unlink(2) - delete a name and possibly the file it refers to. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. */ - function unlink(path: PathLike, callback: NoParamCallback): void; + export function unlink(path: PathLike, callback: NoParamCallback): void; // NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime. - namespace unlink { + export namespace unlink { /** * Asynchronous unlink(2) - delete a name and possibly the file it refers to. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. @@ -725,71 +850,121 @@ declare module "fs" { * Synchronous unlink(2) - delete a name and possibly the file it refers to. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. */ - function unlinkSync(path: PathLike): void; + export function unlinkSync(path: PathLike): void; - interface RmDirOptions { + export interface RmDirOptions { /** + * If an `EBUSY`, `EMFILE`, `ENFILE`, `ENOTEMPTY`, or + * `EPERM` error is encountered, Node.js will retry the operation with a linear + * backoff wait of `retryDelay` ms longer on each try. This option represents the + * number of retries. This option is ignored if the `recursive` option is not + * `true`. + * @default 0 + */ + maxRetries?: number; + /** + * @deprecated since v14.14.0 In future versions of Node.js, + * `fs.rmdir(path, { recursive: true })` will throw on nonexistent + * paths, or when given a file as a target. + * Use `fs.rm(path, { recursive: true, force: true })` instead. + * * If `true`, perform a recursive directory removal. In * recursive mode, errors are not reported if `path` does not exist, and * operations are retried on failure. - * @experimental * @default false */ recursive?: boolean; - } - - interface RmDirAsyncOptions extends RmDirOptions { /** - * If an `EMFILE` error is encountered, Node.js will - * retry the operation with a linear backoff of 1ms longer on each try until the - * timeout duration passes this limit. This option is ignored if the `recursive` - * option is not `true`. - * @default 1000 + * The amount of time in milliseconds to wait between retries. + * This option is ignored if the `recursive` option is not `true`. + * @default 100 */ - emfileWait?: number; - /** - * If an `EBUSY`, `ENOTEMPTY`, or `EPERM` error is - * encountered, Node.js will retry the operation with a linear backoff wait of - * 100ms longer on each try. This option represents the number of retries. This - * option is ignored if the `recursive` option is not `true`. - * @default 3 - */ - maxBusyTries?: number; + retryDelay?: number; } /** * Asynchronous rmdir(2) - delete a directory. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. */ - function rmdir(path: PathLike, callback: NoParamCallback): void; - function rmdir(path: PathLike, options: RmDirAsyncOptions, callback: NoParamCallback): void; + export function rmdir(path: PathLike, callback: NoParamCallback): void; + export function rmdir(path: PathLike, options: RmDirOptions, callback: NoParamCallback): void; // NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime. - namespace rmdir { + export namespace rmdir { /** * Asynchronous rmdir(2) - delete a directory. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. */ - function __promisify__(path: PathLike, options?: RmDirAsyncOptions): Promise; + function __promisify__(path: PathLike, options?: RmDirOptions): Promise; } /** * Synchronous rmdir(2) - delete a directory. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. */ - function rmdirSync(path: PathLike, options?: RmDirOptions): void; + export function rmdirSync(path: PathLike, options?: RmDirOptions): void; - interface MakeDirectoryOptions { + export interface RmOptions { + /** + * When `true`, exceptions will be ignored if `path` does not exist. + * @default false + */ + force?: boolean; + /** + * If an `EBUSY`, `EMFILE`, `ENFILE`, `ENOTEMPTY`, or + * `EPERM` error is encountered, Node.js will retry the operation with a linear + * backoff wait of `retryDelay` ms longer on each try. This option represents the + * number of retries. This option is ignored if the `recursive` option is not + * `true`. + * @default 0 + */ + maxRetries?: number; + /** + * If `true`, perform a recursive directory removal. In + * recursive mode, errors are not reported if `path` does not exist, and + * operations are retried on failure. + * @default false + */ + recursive?: boolean; + /** + * The amount of time in milliseconds to wait between retries. + * This option is ignored if the `recursive` option is not `true`. + * @default 100 + */ + retryDelay?: number; + } + + /** + * Asynchronously removes files and directories (modeled on the standard POSIX `rm` utility). + */ + export function rm(path: PathLike, callback: NoParamCallback): void; + export function rm(path: PathLike, options: RmOptions, callback: NoParamCallback): void; + + // NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime. + export namespace rm { + /** + * Asynchronously removes files and directories (modeled on the standard POSIX `rm` utility). + */ + function __promisify__(path: PathLike, options?: RmOptions): Promise; + } + + /** + * Synchronously removes files and directories (modeled on the standard POSIX `rm` utility). + */ + export function rmSync(path: PathLike, options?: RmOptions): void; + + export interface MakeDirectoryOptions { /** * Indicates whether parent folders should be created. + * If a folder was created, the path to the first created folder will be returned. * @default false */ recursive?: boolean; /** * A file mode. If a string is passed, it is parsed as an octal integer. If not specified - * @default 0o777. + * @default 0o777 */ - mode?: number; + mode?: Mode; } /** @@ -798,23 +973,55 @@ declare module "fs" { * @param options Either the file mode, or an object optionally specifying the file mode and whether parent folders * should be created. If a string is passed, it is parsed as an octal integer. If not specified, defaults to `0o777`. */ - function mkdir(path: PathLike, options: number | string | MakeDirectoryOptions | undefined | null, callback: NoParamCallback): void; + export function mkdir(path: PathLike, options: MakeDirectoryOptions & { recursive: true }, callback: (err: NodeJS.ErrnoException | null, path: string) => void): void; + + /** + * Asynchronous mkdir(2) - create a directory. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param options Either the file mode, or an object optionally specifying the file mode and whether parent folders + * should be created. If a string is passed, it is parsed as an octal integer. If not specified, defaults to `0o777`. + */ + export function mkdir(path: PathLike, options: Mode | (MakeDirectoryOptions & { recursive?: false; }) | null | undefined, callback: NoParamCallback): void; + + /** + * Asynchronous mkdir(2) - create a directory. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param options Either the file mode, or an object optionally specifying the file mode and whether parent folders + * should be created. If a string is passed, it is parsed as an octal integer. If not specified, defaults to `0o777`. + */ + export function mkdir(path: PathLike, options: Mode | MakeDirectoryOptions | null | undefined, callback: (err: NodeJS.ErrnoException | null, path: string | undefined) => void): void; /** * Asynchronous mkdir(2) - create a directory with a mode of `0o777`. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. */ - function mkdir(path: PathLike, callback: NoParamCallback): void; + export function mkdir(path: PathLike, callback: NoParamCallback): void; // NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime. - namespace mkdir { + export namespace mkdir { /** * Asynchronous mkdir(2) - create a directory. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * @param options Either the file mode, or an object optionally specifying the file mode and whether parent folders * should be created. If a string is passed, it is parsed as an octal integer. If not specified, defaults to `0o777`. */ - function __promisify__(path: PathLike, options?: number | string | MakeDirectoryOptions | null): Promise; + function __promisify__(path: PathLike, options: MakeDirectoryOptions & { recursive: true; }): Promise; + + /** + * Asynchronous mkdir(2) - create a directory. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param options Either the file mode, or an object optionally specifying the file mode and whether parent folders + * should be created. If a string is passed, it is parsed as an octal integer. If not specified, defaults to `0o777`. + */ + function __promisify__(path: PathLike, options?: Mode | (MakeDirectoryOptions & { recursive?: false; }) | null): Promise; + + /** + * Asynchronous mkdir(2) - create a directory. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param options Either the file mode, or an object optionally specifying the file mode and whether parent folders + * should be created. If a string is passed, it is parsed as an octal integer. If not specified, defaults to `0o777`. + */ + function __promisify__(path: PathLike, options?: Mode | MakeDirectoryOptions | null): Promise; } /** @@ -823,57 +1030,73 @@ declare module "fs" { * @param options Either the file mode, or an object optionally specifying the file mode and whether parent folders * should be created. If a string is passed, it is parsed as an octal integer. If not specified, defaults to `0o777`. */ - function mkdirSync(path: PathLike, options?: number | string | MakeDirectoryOptions | null): void; + export function mkdirSync(path: PathLike, options: MakeDirectoryOptions & { recursive: true; }): string; + + /** + * Synchronous mkdir(2) - create a directory. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param options Either the file mode, or an object optionally specifying the file mode and whether parent folders + * should be created. If a string is passed, it is parsed as an octal integer. If not specified, defaults to `0o777`. + */ + export function mkdirSync(path: PathLike, options?: Mode | (MakeDirectoryOptions & { recursive?: false; }) | null): void; + + /** + * Synchronous mkdir(2) - create a directory. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param options Either the file mode, or an object optionally specifying the file mode and whether parent folders + * should be created. If a string is passed, it is parsed as an octal integer. If not specified, defaults to `0o777`. + */ + export function mkdirSync(path: PathLike, options?: Mode | MakeDirectoryOptions | null): string | undefined; /** * Asynchronously creates a unique temporary directory. * Generates six random characters to be appended behind a required prefix to create a unique temporary directory. * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. */ - function mkdtemp(prefix: string, options: { encoding?: BufferEncoding | null } | BufferEncoding | undefined | null, callback: (err: NodeJS.ErrnoException | null, folder: string) => void): void; + export function mkdtemp(prefix: string, options: BaseEncodingOptions | BufferEncoding | undefined | null, callback: (err: NodeJS.ErrnoException | null, folder: string) => void): void; /** * Asynchronously creates a unique temporary directory. * Generates six random characters to be appended behind a required prefix to create a unique temporary directory. * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. */ - function mkdtemp(prefix: string, options: "buffer" | { encoding: "buffer" }, callback: (err: NodeJS.ErrnoException | null, folder: Buffer) => void): void; + export function mkdtemp(prefix: string, options: "buffer" | { encoding: "buffer" }, callback: (err: NodeJS.ErrnoException | null, folder: Buffer) => void): void; /** * Asynchronously creates a unique temporary directory. * Generates six random characters to be appended behind a required prefix to create a unique temporary directory. * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. */ - function mkdtemp(prefix: string, options: { encoding?: string | null } | string | undefined | null, callback: (err: NodeJS.ErrnoException | null, folder: string | Buffer) => void): void; + export function mkdtemp(prefix: string, options: BaseEncodingOptions | string | undefined | null, callback: (err: NodeJS.ErrnoException | null, folder: string | Buffer) => void): void; /** * Asynchronously creates a unique temporary directory. * Generates six random characters to be appended behind a required prefix to create a unique temporary directory. */ - function mkdtemp(prefix: string, callback: (err: NodeJS.ErrnoException | null, folder: string) => void): void; + export function mkdtemp(prefix: string, callback: (err: NodeJS.ErrnoException | null, folder: string) => void): void; // NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime. - namespace mkdtemp { + export namespace mkdtemp { /** * Asynchronously creates a unique temporary directory. * Generates six random characters to be appended behind a required prefix to create a unique temporary directory. * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. */ - function __promisify__(prefix: string, options?: { encoding?: BufferEncoding | null } | BufferEncoding | null): Promise; + function __promisify__(prefix: string, options?: BaseEncodingOptions | BufferEncoding | null): Promise; /** * Asynchronously creates a unique temporary directory. * Generates six random characters to be appended behind a required prefix to create a unique temporary directory. * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. */ - function __promisify__(prefix: string, options: { encoding: "buffer" } | "buffer"): Promise; + function __promisify__(prefix: string, options: BufferEncodingOption): Promise; /** * Asynchronously creates a unique temporary directory. * Generates six random characters to be appended behind a required prefix to create a unique temporary directory. * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. */ - function __promisify__(prefix: string, options?: { encoding?: string | null } | string | null): Promise; + function __promisify__(prefix: string, options?: BaseEncodingOptions | string | null): Promise; } /** @@ -881,28 +1104,28 @@ declare module "fs" { * Generates six random characters to be appended behind a required prefix to create a unique temporary directory. * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. */ - function mkdtempSync(prefix: string, options?: { encoding?: BufferEncoding | null } | BufferEncoding | null): string; + export function mkdtempSync(prefix: string, options?: BaseEncodingOptions | BufferEncoding | null): string; /** * Synchronously creates a unique temporary directory. * Generates six random characters to be appended behind a required prefix to create a unique temporary directory. * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. */ - function mkdtempSync(prefix: string, options: { encoding: "buffer" } | "buffer"): Buffer; + export function mkdtempSync(prefix: string, options: BufferEncodingOption): Buffer; /** * Synchronously creates a unique temporary directory. * Generates six random characters to be appended behind a required prefix to create a unique temporary directory. * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. */ - function mkdtempSync(prefix: string, options?: { encoding?: string | null } | string | null): string | Buffer; + export function mkdtempSync(prefix: string, options?: BaseEncodingOptions | string | null): string | Buffer; /** * Asynchronous readdir(3) - read a directory. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. */ - function readdir( + export function readdir( path: PathLike, options: { encoding: BufferEncoding | null; withFileTypes?: false } | BufferEncoding | undefined | null, callback: (err: NodeJS.ErrnoException | null, files: string[]) => void, @@ -913,16 +1136,16 @@ declare module "fs" { * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. */ - function readdir(path: PathLike, options: { encoding: "buffer"; withFileTypes?: false } | "buffer", callback: (err: NodeJS.ErrnoException | null, files: Buffer[]) => void): void; + export function readdir(path: PathLike, options: { encoding: "buffer"; withFileTypes?: false } | "buffer", callback: (err: NodeJS.ErrnoException | null, files: Buffer[]) => void): void; /** * Asynchronous readdir(3) - read a directory. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. */ - function readdir( + export function readdir( path: PathLike, - options: { encoding?: string | null; withFileTypes?: false } | string | undefined | null, + options: BaseEncodingOptions & { withFileTypes?: false } | BufferEncoding | undefined | null, callback: (err: NodeJS.ErrnoException | null, files: string[] | Buffer[]) => void, ): void; @@ -930,17 +1153,17 @@ declare module "fs" { * Asynchronous readdir(3) - read a directory. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. */ - function readdir(path: PathLike, callback: (err: NodeJS.ErrnoException | null, files: string[]) => void): void; + export function readdir(path: PathLike, callback: (err: NodeJS.ErrnoException | null, files: string[]) => void): void; /** * Asynchronous readdir(3) - read a directory. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * @param options If called with `withFileTypes: true` the result data will be an array of Dirent. */ - function readdir(path: PathLike, options: { encoding?: string | null; withFileTypes: true }, callback: (err: NodeJS.ErrnoException | null, files: Dirent[]) => void): void; + export function readdir(path: PathLike, options: BaseEncodingOptions & { withFileTypes: true }, callback: (err: NodeJS.ErrnoException | null, files: Dirent[]) => void): void; // NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime. - namespace readdir { + export namespace readdir { /** * Asynchronous readdir(3) - read a directory. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. @@ -960,14 +1183,14 @@ declare module "fs" { * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. */ - function __promisify__(path: PathLike, options?: { encoding?: string | null; withFileTypes?: false } | string | null): Promise; + function __promisify__(path: PathLike, options?: BaseEncodingOptions & { withFileTypes?: false } | BufferEncoding | null): Promise; /** * Asynchronous readdir(3) - read a directory. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * @param options If called with `withFileTypes: true` the result data will be an array of Dirent */ - function __promisify__(path: PathLike, options: { encoding?: string | null; withFileTypes: true }): Promise; + function __promisify__(path: PathLike, options: BaseEncodingOptions & { withFileTypes: true }): Promise; } /** @@ -975,37 +1198,37 @@ declare module "fs" { * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. */ - function readdirSync(path: PathLike, options?: { encoding: BufferEncoding | null; withFileTypes?: false } | BufferEncoding | null): string[]; + export function readdirSync(path: PathLike, options?: { encoding: BufferEncoding | null; withFileTypes?: false } | BufferEncoding | null): string[]; /** * Synchronous readdir(3) - read a directory. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. */ - function readdirSync(path: PathLike, options: { encoding: "buffer"; withFileTypes?: false } | "buffer"): Buffer[]; + export function readdirSync(path: PathLike, options: { encoding: "buffer"; withFileTypes?: false } | "buffer"): Buffer[]; /** * Synchronous readdir(3) - read a directory. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. */ - function readdirSync(path: PathLike, options?: { encoding?: string | null; withFileTypes?: false } | string | null): string[] | Buffer[]; + export function readdirSync(path: PathLike, options?: BaseEncodingOptions & { withFileTypes?: false } | BufferEncoding | null): string[] | Buffer[]; /** * Synchronous readdir(3) - read a directory. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * @param options If called with `withFileTypes: true` the result data will be an array of Dirent. */ - function readdirSync(path: PathLike, options: { encoding?: string | null; withFileTypes: true }): Dirent[]; + export function readdirSync(path: PathLike, options: BaseEncodingOptions & { withFileTypes: true }): Dirent[]; /** * Asynchronous close(2) - close a file descriptor. * @param fd A file descriptor. */ - function close(fd: number, callback: NoParamCallback): void; + export function close(fd: number, callback: NoParamCallback): void; // NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime. - namespace close { + export namespace close { /** * Asynchronous close(2) - close a file descriptor. * @param fd A file descriptor. @@ -1017,29 +1240,29 @@ declare module "fs" { * Synchronous close(2) - close a file descriptor. * @param fd A file descriptor. */ - function closeSync(fd: number): void; + export function closeSync(fd: number): void; /** * Asynchronous open(2) - open and possibly create a file. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * @param mode A file mode. If a string is passed, it is parsed as an octal integer. If not supplied, defaults to `0o666`. */ - function open(path: PathLike, flags: string | number, mode: string | number | undefined | null, callback: (err: NodeJS.ErrnoException | null, fd: number) => void): void; + export function open(path: PathLike, flags: OpenMode, mode: Mode | undefined | null, callback: (err: NodeJS.ErrnoException | null, fd: number) => void): void; /** * Asynchronous open(2) - open and possibly create a file. If the file is created, its mode will be `0o666`. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. */ - function open(path: PathLike, flags: string | number, callback: (err: NodeJS.ErrnoException | null, fd: number) => void): void; + export function open(path: PathLike, flags: OpenMode, callback: (err: NodeJS.ErrnoException | null, fd: number) => void): void; // NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime. - namespace open { + export namespace open { /** * Asynchronous open(2) - open and possibly create a file. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * @param mode A file mode. If a string is passed, it is parsed as an octal integer. If not supplied, defaults to `0o666`. */ - function __promisify__(path: PathLike, flags: string | number, mode?: string | number | null): Promise; + function __promisify__(path: PathLike, flags: OpenMode, mode?: Mode | null): Promise; } /** @@ -1047,7 +1270,7 @@ declare module "fs" { * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * @param mode A file mode. If a string is passed, it is parsed as an octal integer. If not supplied, defaults to `0o666`. */ - function openSync(path: PathLike, flags: string | number, mode?: string | number | null): number; + export function openSync(path: PathLike, flags: OpenMode, mode?: Mode | null): number; /** * Asynchronously change file timestamps of the file referenced by the supplied path. @@ -1055,10 +1278,10 @@ declare module "fs" { * @param atime The last access time. If a string is provided, it will be coerced to number. * @param mtime The last modified time. If a string is provided, it will be coerced to number. */ - function utimes(path: PathLike, atime: string | number | Date, mtime: string | number | Date, callback: NoParamCallback): void; + export function utimes(path: PathLike, atime: string | number | Date, mtime: string | number | Date, callback: NoParamCallback): void; // NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime. - namespace utimes { + export namespace utimes { /** * Asynchronously change file timestamps of the file referenced by the supplied path. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. @@ -1074,7 +1297,7 @@ declare module "fs" { * @param atime The last access time. If a string is provided, it will be coerced to number. * @param mtime The last modified time. If a string is provided, it will be coerced to number. */ - function utimesSync(path: PathLike, atime: string | number | Date, mtime: string | number | Date): void; + export function utimesSync(path: PathLike, atime: string | number | Date, mtime: string | number | Date): void; /** * Asynchronously change file timestamps of the file referenced by the supplied file descriptor. @@ -1082,10 +1305,10 @@ declare module "fs" { * @param atime The last access time. If a string is provided, it will be coerced to number. * @param mtime The last modified time. If a string is provided, it will be coerced to number. */ - function futimes(fd: number, atime: string | number | Date, mtime: string | number | Date, callback: NoParamCallback): void; + export function futimes(fd: number, atime: string | number | Date, mtime: string | number | Date, callback: NoParamCallback): void; // NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime. - namespace futimes { + export namespace futimes { /** * Asynchronously change file timestamps of the file referenced by the supplied file descriptor. * @param fd A file descriptor. @@ -1101,16 +1324,16 @@ declare module "fs" { * @param atime The last access time. If a string is provided, it will be coerced to number. * @param mtime The last modified time. If a string is provided, it will be coerced to number. */ - function futimesSync(fd: number, atime: string | number | Date, mtime: string | number | Date): void; + export function futimesSync(fd: number, atime: string | number | Date, mtime: string | number | Date): void; /** * Asynchronous fsync(2) - synchronize a file's in-core state with the underlying storage device. * @param fd A file descriptor. */ - function fsync(fd: number, callback: NoParamCallback): void; + export function fsync(fd: number, callback: NoParamCallback): void; // NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime. - namespace fsync { + export namespace fsync { /** * Asynchronous fsync(2) - synchronize a file's in-core state with the underlying storage device. * @param fd A file descriptor. @@ -1122,7 +1345,7 @@ declare module "fs" { * Synchronous fsync(2) - synchronize a file's in-core state with the underlying storage device. * @param fd A file descriptor. */ - function fsyncSync(fd: number): void; + export function fsyncSync(fd: number): void; /** * Asynchronously writes `buffer` to the file referenced by the supplied file descriptor. @@ -1131,7 +1354,7 @@ declare module "fs" { * @param length The number of bytes to write. If not supplied, defaults to `buffer.length - offset`. * @param position The offset from the beginning of the file where this data should be written. If not supplied, defaults to the current position. */ - function write( + export function write( fd: number, buffer: TBuffer, offset: number | undefined | null, @@ -1146,7 +1369,7 @@ declare module "fs" { * @param offset The part of the buffer to be written. If not supplied, defaults to `0`. * @param length The number of bytes to write. If not supplied, defaults to `buffer.length - offset`. */ - function write( + export function write( fd: number, buffer: TBuffer, offset: number | undefined | null, @@ -1159,7 +1382,7 @@ declare module "fs" { * @param fd A file descriptor. * @param offset The part of the buffer to be written. If not supplied, defaults to `0`. */ - function write( + export function write( fd: number, buffer: TBuffer, offset: number | undefined | null, @@ -1170,40 +1393,40 @@ declare module "fs" { * Asynchronously writes `buffer` to the file referenced by the supplied file descriptor. * @param fd A file descriptor. */ - function write(fd: number, buffer: TBuffer, callback: (err: NodeJS.ErrnoException | null, written: number, buffer: TBuffer) => void): void; + export function write(fd: number, buffer: TBuffer, callback: (err: NodeJS.ErrnoException | null, written: number, buffer: TBuffer) => void): void; /** * Asynchronously writes `string` to the file referenced by the supplied file descriptor. * @param fd A file descriptor. - * @param string A string to write. If something other than a string is supplied it will be coerced to a string. + * @param string A string to write. * @param position The offset from the beginning of the file where this data should be written. If not supplied, defaults to the current position. * @param encoding The expected string encoding. */ - function write( + export function write( fd: number, - string: any, + string: string, position: number | undefined | null, - encoding: string | undefined | null, + encoding: BufferEncoding | undefined | null, callback: (err: NodeJS.ErrnoException | null, written: number, str: string) => void, ): void; /** * Asynchronously writes `string` to the file referenced by the supplied file descriptor. * @param fd A file descriptor. - * @param string A string to write. If something other than a string is supplied it will be coerced to a string. + * @param string A string to write. * @param position The offset from the beginning of the file where this data should be written. If not supplied, defaults to the current position. */ - function write(fd: number, string: any, position: number | undefined | null, callback: (err: NodeJS.ErrnoException | null, written: number, str: string) => void): void; + export function write(fd: number, string: string, position: number | undefined | null, callback: (err: NodeJS.ErrnoException | null, written: number, str: string) => void): void; /** * Asynchronously writes `string` to the file referenced by the supplied file descriptor. * @param fd A file descriptor. - * @param string A string to write. If something other than a string is supplied it will be coerced to a string. + * @param string A string to write. */ - function write(fd: number, string: any, callback: (err: NodeJS.ErrnoException | null, written: number, str: string) => void): void; + export function write(fd: number, string: string, callback: (err: NodeJS.ErrnoException | null, written: number, str: string) => void): void; // NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime. - namespace write { + export namespace write { /** * Asynchronously writes `buffer` to the file referenced by the supplied file descriptor. * @param fd A file descriptor. @@ -1222,11 +1445,11 @@ declare module "fs" { /** * Asynchronously writes `string` to the file referenced by the supplied file descriptor. * @param fd A file descriptor. - * @param string A string to write. If something other than a string is supplied it will be coerced to a string. + * @param string A string to write. * @param position The offset from the beginning of the file where this data should be written. If not supplied, defaults to the current position. * @param encoding The expected string encoding. */ - function __promisify__(fd: number, string: any, position?: number | null, encoding?: string | null): Promise<{ bytesWritten: number, buffer: string }>; + function __promisify__(fd: number, string: string, position?: number | null, encoding?: BufferEncoding | null): Promise<{ bytesWritten: number, buffer: string }>; } /** @@ -1236,16 +1459,16 @@ declare module "fs" { * @param length The number of bytes to write. If not supplied, defaults to `buffer.length - offset`. * @param position The offset from the beginning of the file where this data should be written. If not supplied, defaults to the current position. */ - function writeSync(fd: number, buffer: NodeJS.ArrayBufferView, offset?: number | null, length?: number | null, position?: number | null): number; + export function writeSync(fd: number, buffer: NodeJS.ArrayBufferView, offset?: number | null, length?: number | null, position?: number | null): number; /** * Synchronously writes `string` to the file referenced by the supplied file descriptor, returning the number of bytes written. * @param fd A file descriptor. - * @param string A string to write. If something other than a string is supplied it will be coerced to a string. + * @param string A string to write. * @param position The offset from the beginning of the file where this data should be written. If not supplied, defaults to the current position. * @param encoding The expected string encoding. */ - function writeSync(fd: number, string: any, position?: number | null, encoding?: string | null): number; + export function writeSync(fd: number, string: string, position?: number | null, encoding?: BufferEncoding | null): number; /** * Asynchronously reads data from the file referenced by the supplied file descriptor. @@ -1255,7 +1478,7 @@ declare module "fs" { * @param length The number of bytes to read. * @param position The offset from the beginning of the file from which data should be read. If `null`, data will be read from the current position. */ - function read( + export function read( fd: number, buffer: TBuffer, offset: number, @@ -1265,7 +1488,7 @@ declare module "fs" { ): void; // NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime. - namespace read { + export namespace read { /** * @param fd A file descriptor. * @param buffer The buffer that the data will be written to. @@ -1282,6 +1505,21 @@ declare module "fs" { ): Promise<{ bytesRead: number, buffer: TBuffer }>; } + export interface ReadSyncOptions { + /** + * @default 0 + */ + offset?: number; + /** + * @default `length of buffer` + */ + length?: number; + /** + * @default null + */ + position?: number | null; + } + /** * Synchronously reads data from the file referenced by the supplied file descriptor, returning the number of bytes read. * @param fd A file descriptor. @@ -1290,7 +1528,13 @@ declare module "fs" { * @param length The number of bytes to read. * @param position The offset from the beginning of the file from which data should be read. If `null`, data will be read from the current position. */ - function readSync(fd: number, buffer: NodeJS.ArrayBufferView, offset: number, length: number, position: number | null): number; + export function readSync(fd: number, buffer: NodeJS.ArrayBufferView, offset: number, length: number, position: number | null): number; + + /** + * Similar to the above `fs.readSync` function, this version takes an optional `options` object. + * If no `options` object is specified, it will default with the above values. + */ + export function readSync(fd: number, buffer: NodeJS.ArrayBufferView, opts?: ReadSyncOptions): number; /** * Asynchronously reads the entire contents of a file. @@ -1299,7 +1543,7 @@ declare module "fs" { * @param options An object that may contain an optional flag. * If a flag is not provided, it defaults to `'r'`. */ - function readFile(path: PathLike | number, options: { encoding?: null; flag?: string; } | undefined | null, callback: (err: NodeJS.ErrnoException | null, data: Buffer) => void): void; + export function readFile(path: PathLike | number, options: { encoding?: null; flag?: string; } | undefined | null, callback: (err: NodeJS.ErrnoException | null, data: Buffer) => void): void; /** * Asynchronously reads the entire contents of a file. @@ -1309,7 +1553,7 @@ declare module "fs" { * @param options Either the encoding for the result, or an object that contains the encoding and an optional flag. * If a flag is not provided, it defaults to `'r'`. */ - function readFile(path: PathLike | number, options: { encoding: string; flag?: string; } | string, callback: (err: NodeJS.ErrnoException | null, data: string) => void): void; + export function readFile(path: PathLike | number, options: { encoding: BufferEncoding; flag?: string; } | string, callback: (err: NodeJS.ErrnoException | null, data: string) => void): void; /** * Asynchronously reads the entire contents of a file. @@ -1319,9 +1563,9 @@ declare module "fs" { * @param options Either the encoding for the result, or an object that contains the encoding and an optional flag. * If a flag is not provided, it defaults to `'r'`. */ - function readFile( + export function readFile( path: PathLike | number, - options: { encoding?: string | null; flag?: string; } | string | undefined | null, + options: BaseEncodingOptions & { flag?: string; } | string | undefined | null, callback: (err: NodeJS.ErrnoException | null, data: string | Buffer) => void, ): void; @@ -1330,10 +1574,10 @@ declare module "fs" { * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * If a file descriptor is provided, the underlying file will _not_ be closed automatically. */ - function readFile(path: PathLike | number, callback: (err: NodeJS.ErrnoException | null, data: Buffer) => void): void; + export function readFile(path: PathLike | number, callback: (err: NodeJS.ErrnoException | null, data: Buffer) => void): void; // NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime. - namespace readFile { + export namespace readFile { /** * Asynchronously reads the entire contents of a file. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. @@ -1351,7 +1595,7 @@ declare module "fs" { * @param options Either the encoding for the result, or an object that contains the encoding and an optional flag. * If a flag is not provided, it defaults to `'r'`. */ - function __promisify__(path: PathLike | number, options: { encoding: string; flag?: string; } | string): Promise; + function __promisify__(path: PathLike | number, options: { encoding: BufferEncoding; flag?: string; } | string): Promise; /** * Asynchronously reads the entire contents of a file. @@ -1361,7 +1605,7 @@ declare module "fs" { * @param options Either the encoding for the result, or an object that contains the encoding and an optional flag. * If a flag is not provided, it defaults to `'r'`. */ - function __promisify__(path: PathLike | number, options?: { encoding?: string | null; flag?: string; } | string | null): Promise; + function __promisify__(path: PathLike | number, options?: BaseEncodingOptions & { flag?: string; } | string | null): Promise; } /** @@ -1371,7 +1615,7 @@ declare module "fs" { * If a file descriptor is provided, the underlying file will _not_ be closed automatically. * @param options An object that may contain an optional flag. If a flag is not provided, it defaults to `'r'`. */ - function readFileSync(path: PathLike | number, options?: { encoding?: null; flag?: string; } | null): Buffer; + export function readFileSync(path: PathLike | number, options?: { encoding?: null; flag?: string; } | null): Buffer; /** * Synchronously reads the entire contents of a file. @@ -1381,7 +1625,7 @@ declare module "fs" { * @param options Either the encoding for the result, or an object that contains the encoding and an optional flag. * If a flag is not provided, it defaults to `'r'`. */ - function readFileSync(path: PathLike | number, options: { encoding: string; flag?: string; } | string): string; + export function readFileSync(path: PathLike | number, options: { encoding: BufferEncoding; flag?: string; } | BufferEncoding): string; /** * Synchronously reads the entire contents of a file. @@ -1391,9 +1635,9 @@ declare module "fs" { * @param options Either the encoding for the result, or an object that contains the encoding and an optional flag. * If a flag is not provided, it defaults to `'r'`. */ - function readFileSync(path: PathLike | number, options?: { encoding?: string | null; flag?: string; } | string | null): string | Buffer; + export function readFileSync(path: PathLike | number, options?: BaseEncodingOptions & { flag?: string; } | BufferEncoding | null): string | Buffer; - type WriteFileOptions = { encoding?: string | null; mode?: number | string; flag?: string; } | string | null; + export type WriteFileOptions = BaseEncodingOptions & { mode?: Mode; flag?: string; } | string | null; /** * Asynchronously writes data to a file, replacing the file if it already exists. @@ -1407,7 +1651,7 @@ declare module "fs" { * If `mode` is a string, it is parsed as an octal integer. * If `flag` is not supplied, the default of `'w'` is used. */ - function writeFile(path: PathLike | number, data: any, options: WriteFileOptions, callback: NoParamCallback): void; + export function writeFile(path: PathLike | number, data: string | NodeJS.ArrayBufferView, options: WriteFileOptions, callback: NoParamCallback): void; /** * Asynchronously writes data to a file, replacing the file if it already exists. @@ -1416,10 +1660,10 @@ declare module "fs" { * If a file descriptor is provided, the underlying file will _not_ be closed automatically. * @param data The data to write. If something other than a Buffer or Uint8Array is provided, the value is coerced to a string. */ - function writeFile(path: PathLike | number, data: any, callback: NoParamCallback): void; + export function writeFile(path: PathLike | number, data: string | NodeJS.ArrayBufferView, callback: NoParamCallback): void; // NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime. - namespace writeFile { + export namespace writeFile { /** * Asynchronously writes data to a file, replacing the file if it already exists. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. @@ -1432,7 +1676,7 @@ declare module "fs" { * If `mode` is a string, it is parsed as an octal integer. * If `flag` is not supplied, the default of `'w'` is used. */ - function __promisify__(path: PathLike | number, data: any, options?: WriteFileOptions): Promise; + function __promisify__(path: PathLike | number, data: string | NodeJS.ArrayBufferView, options?: WriteFileOptions): Promise; } /** @@ -1447,7 +1691,7 @@ declare module "fs" { * If `mode` is a string, it is parsed as an octal integer. * If `flag` is not supplied, the default of `'w'` is used. */ - function writeFileSync(path: PathLike | number, data: any, options?: WriteFileOptions): void; + export function writeFileSync(path: PathLike | number, data: string | NodeJS.ArrayBufferView, options?: WriteFileOptions): void; /** * Asynchronously append data to a file, creating the file if it does not exist. @@ -1461,7 +1705,7 @@ declare module "fs" { * If `mode` is a string, it is parsed as an octal integer. * If `flag` is not supplied, the default of `'a'` is used. */ - function appendFile(file: PathLike | number, data: any, options: WriteFileOptions, callback: NoParamCallback): void; + export function appendFile(file: PathLike | number, data: string | Uint8Array, options: WriteFileOptions, callback: NoParamCallback): void; /** * Asynchronously append data to a file, creating the file if it does not exist. @@ -1470,10 +1714,10 @@ declare module "fs" { * If a file descriptor is provided, the underlying file will _not_ be closed automatically. * @param data The data to write. If something other than a Buffer or Uint8Array is provided, the value is coerced to a string. */ - function appendFile(file: PathLike | number, data: any, callback: NoParamCallback): void; + export function appendFile(file: PathLike | number, data: string | Uint8Array, callback: NoParamCallback): void; // NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime. - namespace appendFile { + export namespace appendFile { /** * Asynchronously append data to a file, creating the file if it does not exist. * @param file A path to a file. If a URL is provided, it must use the `file:` protocol. @@ -1486,7 +1730,7 @@ declare module "fs" { * If `mode` is a string, it is parsed as an octal integer. * If `flag` is not supplied, the default of `'a'` is used. */ - function __promisify__(file: PathLike | number, data: any, options?: WriteFileOptions): Promise; + function __promisify__(file: PathLike | number, data: string | Uint8Array, options?: WriteFileOptions): Promise; } /** @@ -1501,26 +1745,26 @@ declare module "fs" { * If `mode` is a string, it is parsed as an octal integer. * If `flag` is not supplied, the default of `'a'` is used. */ - function appendFileSync(file: PathLike | number, data: any, options?: WriteFileOptions): void; + export function appendFileSync(file: PathLike | number, data: string | Uint8Array, options?: WriteFileOptions): void; /** * Watch for changes on `filename`. The callback `listener` will be called each time the file is accessed. */ - function watchFile(filename: PathLike, options: { persistent?: boolean; interval?: number; } | undefined, listener: (curr: Stats, prev: Stats) => void): void; + export function watchFile(filename: PathLike, options: { persistent?: boolean; interval?: number; } | undefined, listener: (curr: Stats, prev: Stats) => void): void; /** * Watch for changes on `filename`. The callback `listener` will be called each time the file is accessed. * @param filename A path to a file or directory. If a URL is provided, it must use the `file:` protocol. * URL support is _experimental_. */ - function watchFile(filename: PathLike, listener: (curr: Stats, prev: Stats) => void): void; + export function watchFile(filename: PathLike, listener: (curr: Stats, prev: Stats) => void): void; /** * Stop watching for changes on `filename`. * @param filename A path to a file or directory. If a URL is provided, it must use the `file:` protocol. * URL support is _experimental_. */ - function unwatchFile(filename: PathLike, listener?: (curr: Stats, prev: Stats) => void): void; + export function unwatchFile(filename: PathLike, listener?: (curr: Stats, prev: Stats) => void): void; /** * Watch for changes on `filename`, where `filename` is either a file or a directory, returning an `FSWatcher`. @@ -1531,7 +1775,7 @@ declare module "fs" { * If `persistent` is not supplied, the default of `true` is used. * If `recursive` is not supplied, the default of `false` is used. */ - function watch( + export function watch( filename: PathLike, options: { encoding?: BufferEncoding | null, persistent?: boolean, recursive?: boolean } | BufferEncoding | undefined | null, listener?: (event: string, filename: string) => void, @@ -1546,7 +1790,7 @@ declare module "fs" { * If `persistent` is not supplied, the default of `true` is used. * If `recursive` is not supplied, the default of `false` is used. */ - function watch(filename: PathLike, options: { encoding: "buffer", persistent?: boolean, recursive?: boolean } | "buffer", listener?: (event: string, filename: Buffer) => void): FSWatcher; + export function watch(filename: PathLike, options: { encoding: "buffer", persistent?: boolean, recursive?: boolean } | "buffer", listener?: (event: string, filename: Buffer) => void): FSWatcher; /** * Watch for changes on `filename`, where `filename` is either a file or a directory, returning an `FSWatcher`. @@ -1557,9 +1801,9 @@ declare module "fs" { * If `persistent` is not supplied, the default of `true` is used. * If `recursive` is not supplied, the default of `false` is used. */ - function watch( + export function watch( filename: PathLike, - options: { encoding?: string | null, persistent?: boolean, recursive?: boolean } | string | null, + options: { encoding?: BufferEncoding | null, persistent?: boolean, recursive?: boolean } | string | null, listener?: (event: string, filename: string | Buffer) => void, ): FSWatcher; @@ -1568,18 +1812,18 @@ declare module "fs" { * @param filename A path to a file or directory. If a URL is provided, it must use the `file:` protocol. * URL support is _experimental_. */ - function watch(filename: PathLike, listener?: (event: string, filename: string) => any): FSWatcher; + export function watch(filename: PathLike, listener?: (event: string, filename: string) => any): FSWatcher; /** * Asynchronously tests whether or not the given path exists by checking with the file system. - * @deprecated + * @deprecated since v1.0.0 Use `fs.stat()` or `fs.access()` instead * @param path A path to a file or directory. If a URL is provided, it must use the `file:` protocol. * URL support is _experimental_. */ - function exists(path: PathLike, callback: (exists: boolean) => void): void; + export function exists(path: PathLike, callback: (exists: boolean) => void): void; // NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime. - namespace exists { + export namespace exists { /** * @param path A path to a file or directory. If a URL is provided, it must use the `file:` protocol. * URL support is _experimental_. @@ -1592,9 +1836,9 @@ declare module "fs" { * @param path A path to a file or directory. If a URL is provided, it must use the `file:` protocol. * URL support is _experimental_. */ - function existsSync(path: PathLike): boolean; + export function existsSync(path: PathLike): boolean; - namespace constants { + export namespace constants { // File Access Constants /** Constant for fs.access(). File is visible to the calling process. */ @@ -1762,17 +2006,17 @@ declare module "fs" { * @param path A path to a file or directory. If a URL is provided, it must use the `file:` protocol. * URL support is _experimental_. */ - function access(path: PathLike, mode: number | undefined, callback: NoParamCallback): void; + export function access(path: PathLike, mode: number | undefined, callback: NoParamCallback): void; /** * Asynchronously tests a user's permissions for the file specified by path. * @param path A path to a file or directory. If a URL is provided, it must use the `file:` protocol. * URL support is _experimental_. */ - function access(path: PathLike, callback: NoParamCallback): void; + export function access(path: PathLike, callback: NoParamCallback): void; // NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime. - namespace access { + export namespace access { /** * Asynchronously tests a user's permissions for the file specified by path. * @param path A path to a file or directory. If a URL is provided, it must use the `file:` protocol. @@ -1786,16 +2030,16 @@ declare module "fs" { * @param path A path to a file or directory. If a URL is provided, it must use the `file:` protocol. * URL support is _experimental_. */ - function accessSync(path: PathLike, mode?: number): void; + export function accessSync(path: PathLike, mode?: number): void; /** * Returns a new `ReadStream` object. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * URL support is _experimental_. */ - function createReadStream(path: PathLike, options?: string | { + export function createReadStream(path: PathLike, options?: string | { flags?: string; - encoding?: string; + encoding?: BufferEncoding; fd?: number; mode?: number; autoClose?: boolean; @@ -1813,12 +2057,13 @@ declare module "fs" { * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * URL support is _experimental_. */ - function createWriteStream(path: PathLike, options?: string | { + export function createWriteStream(path: PathLike, options?: string | { flags?: string; - encoding?: string; + encoding?: BufferEncoding; fd?: number; mode?: number; autoClose?: boolean; + emitClose?: boolean; start?: number; highWaterMark?: number; }): WriteStream; @@ -1827,10 +2072,10 @@ declare module "fs" { * Asynchronous fdatasync(2) - synchronize a file's in-core state with storage device. * @param fd A file descriptor. */ - function fdatasync(fd: number, callback: NoParamCallback): void; + export function fdatasync(fd: number, callback: NoParamCallback): void; // NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime. - namespace fdatasync { + export namespace fdatasync { /** * Asynchronous fdatasync(2) - synchronize a file's in-core state with storage device. * @param fd A file descriptor. @@ -1842,7 +2087,7 @@ declare module "fs" { * Synchronous fdatasync(2) - synchronize a file's in-core state with storage device. * @param fd A file descriptor. */ - function fdatasyncSync(fd: number): void; + export function fdatasyncSync(fd: number): void; /** * Asynchronously copies src to dest. By default, dest is overwritten if it already exists. @@ -1853,7 +2098,7 @@ declare module "fs" { * @param src A path to the source file. * @param dest A path to the destination file. */ - function copyFile(src: PathLike, dest: PathLike, callback: NoParamCallback): void; + export function copyFile(src: PathLike, dest: PathLike, callback: NoParamCallback): void; /** * Asynchronously copies src to dest. By default, dest is overwritten if it already exists. * No arguments other than a possible exception are given to the callback function. @@ -1864,10 +2109,10 @@ declare module "fs" { * @param dest A path to the destination file. * @param flags An integer that specifies the behavior of the copy operation. The only supported flag is fs.constants.COPYFILE_EXCL, which causes the copy operation to fail if dest already exists. */ - function copyFile(src: PathLike, dest: PathLike, flags: number, callback: NoParamCallback): void; + export function copyFile(src: PathLike, dest: PathLike, flags: number, callback: NoParamCallback): void; // NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime. - namespace copyFile { + export namespace copyFile { /** * Asynchronously copies src to dest. By default, dest is overwritten if it already exists. * No arguments other than a possible exception are given to the callback function. @@ -1893,7 +2138,7 @@ declare module "fs" { * @param flags An optional integer that specifies the behavior of the copy operation. * The only supported flag is fs.constants.COPYFILE_EXCL, which causes the copy operation to fail if dest already exists. */ - function copyFileSync(src: PathLike, dest: PathLike, flags?: number): void; + export function copyFileSync(src: PathLike, dest: PathLike, flags?: number): void; /** * Write an array of ArrayBufferViews to the file specified by fd using writev(). @@ -1902,545 +2147,93 @@ declare module "fs" { * On Linux, positional writes don't work when the file is opened in append mode. * The kernel ignores the position argument and always appends the data to the end of the file. */ - function writev( + export function writev( fd: number, - buffers: NodeJS.ArrayBufferView[], + buffers: ReadonlyArray, cb: (err: NodeJS.ErrnoException | null, bytesWritten: number, buffers: NodeJS.ArrayBufferView[]) => void ): void; - function writev( + export function writev( fd: number, - buffers: NodeJS.ArrayBufferView[], + buffers: ReadonlyArray, position: number, cb: (err: NodeJS.ErrnoException | null, bytesWritten: number, buffers: NodeJS.ArrayBufferView[]) => void ): void; - interface WriteVResult { + export interface WriteVResult { bytesWritten: number; buffers: NodeJS.ArrayBufferView[]; } - namespace writev { - function __promisify__(fd: number, buffers: NodeJS.ArrayBufferView[], position?: number): Promise; + export namespace writev { + function __promisify__(fd: number, buffers: ReadonlyArray, position?: number): Promise; } /** * See `writev`. */ - function writevSync(fd: number, buffers: NodeJS.ArrayBufferView[], position?: number): number; + export function writevSync(fd: number, buffers: ReadonlyArray, position?: number): number; - interface OpenDirOptions { - encoding?: BufferEncoding; + export function readv( + fd: number, + buffers: ReadonlyArray, + cb: (err: NodeJS.ErrnoException | null, bytesRead: number, buffers: NodeJS.ArrayBufferView[]) => void + ): void; + export function readv( + fd: number, + buffers: ReadonlyArray, + position: number, + cb: (err: NodeJS.ErrnoException | null, bytesRead: number, buffers: NodeJS.ArrayBufferView[]) => void + ): void; + + export interface ReadVResult { + bytesRead: number; + buffers: NodeJS.ArrayBufferView[]; } - function opendirSync(path: string, options?: OpenDirOptions): Dir; + export namespace readv { + function __promisify__(fd: number, buffers: ReadonlyArray, position?: number): Promise; + } - function opendir(path: string, cb: (err: NodeJS.ErrnoException | null, dir: Dir) => void): void; - function opendir(path: string, options: OpenDirOptions, cb: (err: NodeJS.ErrnoException | null, dir: Dir) => void): void; + /** + * See `readv`. + */ + export function readvSync(fd: number, buffers: ReadonlyArray, position?: number): number; - namespace opendir { + export interface OpenDirOptions { + encoding?: BufferEncoding; + /** + * Number of directory entries that are buffered + * internally when reading from the directory. Higher values lead to better + * performance but higher memory usage. + * @default 32 + */ + bufferSize?: number; + } + + export function opendirSync(path: string, options?: OpenDirOptions): Dir; + + export function opendir(path: string, cb: (err: NodeJS.ErrnoException | null, dir: Dir) => void): void; + export function opendir(path: string, options: OpenDirOptions, cb: (err: NodeJS.ErrnoException | null, dir: Dir) => void): void; + + export namespace opendir { function __promisify__(path: string, options?: OpenDirOptions): Promise

; } - namespace promises { - interface FileHandle { - /** - * Gets the file descriptor for this file handle. - */ - readonly fd: number; + export interface BigIntStats extends StatsBase { + } - /** - * Asynchronously append data to a file, creating the file if it does not exist. The underlying file will _not_ be closed automatically. - * The `FileHandle` must have been opened for appending. - * @param data The data to write. If something other than a `Buffer` or `Uint8Array` is provided, the value is coerced to a string. - * @param options Either the encoding for the file, or an object optionally specifying the encoding, file mode, and flag. - * If `encoding` is not supplied, the default of `'utf8'` is used. - * If `mode` is not supplied, the default of `0o666` is used. - * If `mode` is a string, it is parsed as an octal integer. - * If `flag` is not supplied, the default of `'a'` is used. - */ - appendFile(data: any, options?: { encoding?: string | null, mode?: string | number, flag?: string | number } | string | null): Promise; + export class BigIntStats { + atimeNs: bigint; + mtimeNs: bigint; + ctimeNs: bigint; + birthtimeNs: bigint; + } - /** - * Asynchronous fchown(2) - Change ownership of a file. - */ - chown(uid: number, gid: number): Promise; + export interface BigIntOptions { + bigint: true; + } - /** - * Asynchronous fchmod(2) - Change permissions of a file. - * @param mode A file mode. If a string is passed, it is parsed as an octal integer. - */ - chmod(mode: string | number): Promise; - - /** - * Asynchronous fdatasync(2) - synchronize a file's in-core state with storage device. - */ - datasync(): Promise; - - /** - * Asynchronous fsync(2) - synchronize a file's in-core state with the underlying storage device. - */ - sync(): Promise; - - /** - * Asynchronously reads data from the file. - * The `FileHandle` must have been opened for reading. - * @param buffer The buffer that the data will be written to. - * @param offset The offset in the buffer at which to start writing. - * @param length The number of bytes to read. - * @param position The offset from the beginning of the file from which data should be read. If `null`, data will be read from the current position. - */ - read(buffer: TBuffer, offset?: number | null, length?: number | null, position?: number | null): Promise<{ bytesRead: number, buffer: TBuffer }>; - - /** - * Asynchronously reads the entire contents of a file. The underlying file will _not_ be closed automatically. - * The `FileHandle` must have been opened for reading. - * @param options An object that may contain an optional flag. - * If a flag is not provided, it defaults to `'r'`. - */ - readFile(options?: { encoding?: null, flag?: string | number } | null): Promise; - - /** - * Asynchronously reads the entire contents of a file. The underlying file will _not_ be closed automatically. - * The `FileHandle` must have been opened for reading. - * @param options An object that may contain an optional flag. - * If a flag is not provided, it defaults to `'r'`. - */ - readFile(options: { encoding: BufferEncoding, flag?: string | number } | BufferEncoding): Promise; - - /** - * Asynchronously reads the entire contents of a file. The underlying file will _not_ be closed automatically. - * The `FileHandle` must have been opened for reading. - * @param options An object that may contain an optional flag. - * If a flag is not provided, it defaults to `'r'`. - */ - readFile(options?: { encoding?: string | null, flag?: string | number } | string | null): Promise; - - /** - * Asynchronous fstat(2) - Get file status. - */ - stat(): Promise; - - /** - * Asynchronous ftruncate(2) - Truncate a file to a specified length. - * @param len If not specified, defaults to `0`. - */ - truncate(len?: number): Promise; - - /** - * Asynchronously change file timestamps of the file. - * @param atime The last access time. If a string is provided, it will be coerced to number. - * @param mtime The last modified time. If a string is provided, it will be coerced to number. - */ - utimes(atime: string | number | Date, mtime: string | number | Date): Promise; - - /** - * Asynchronously writes `buffer` to the file. - * The `FileHandle` must have been opened for writing. - * @param buffer The buffer that the data will be written to. - * @param offset The part of the buffer to be written. If not supplied, defaults to `0`. - * @param length The number of bytes to write. If not supplied, defaults to `buffer.length - offset`. - * @param position The offset from the beginning of the file where this data should be written. If not supplied, defaults to the current position. - */ - write(buffer: TBuffer, offset?: number | null, length?: number | null, position?: number | null): Promise<{ bytesWritten: number, buffer: TBuffer }>; - - /** - * Asynchronously writes `string` to the file. - * The `FileHandle` must have been opened for writing. - * It is unsafe to call `write()` multiple times on the same file without waiting for the `Promise` - * to be resolved (or rejected). For this scenario, `fs.createWriteStream` is strongly recommended. - * @param string A string to write. If something other than a string is supplied it will be coerced to a string. - * @param position The offset from the beginning of the file where this data should be written. If not supplied, defaults to the current position. - * @param encoding The expected string encoding. - */ - write(data: any, position?: number | null, encoding?: string | null): Promise<{ bytesWritten: number, buffer: string }>; - - /** - * Asynchronously writes data to a file, replacing the file if it already exists. The underlying file will _not_ be closed automatically. - * The `FileHandle` must have been opened for writing. - * It is unsafe to call `writeFile()` multiple times on the same file without waiting for the `Promise` to be resolved (or rejected). - * @param data The data to write. If something other than a `Buffer` or `Uint8Array` is provided, the value is coerced to a string. - * @param options Either the encoding for the file, or an object optionally specifying the encoding, file mode, and flag. - * If `encoding` is not supplied, the default of `'utf8'` is used. - * If `mode` is not supplied, the default of `0o666` is used. - * If `mode` is a string, it is parsed as an octal integer. - * If `flag` is not supplied, the default of `'w'` is used. - */ - writeFile(data: any, options?: { encoding?: string | null, mode?: string | number, flag?: string | number } | string | null): Promise; - - /** - * See `fs.writev` promisified version. - */ - writev(buffers: NodeJS.ArrayBufferView[], position?: number): Promise; - - /** - * Asynchronous close(2) - close a `FileHandle`. - */ - close(): Promise; - } - - /** - * Asynchronously tests a user's permissions for the file specified by path. - * @param path A path to a file or directory. If a URL is provided, it must use the `file:` protocol. - * URL support is _experimental_. - */ - function access(path: PathLike, mode?: number): Promise; - - /** - * Asynchronously copies `src` to `dest`. By default, `dest` is overwritten if it already exists. - * Node.js makes no guarantees about the atomicity of the copy operation. - * If an error occurs after the destination file has been opened for writing, Node.js will attempt - * to remove the destination. - * @param src A path to the source file. - * @param dest A path to the destination file. - * @param flags An optional integer that specifies the behavior of the copy operation. The only - * supported flag is `fs.constants.COPYFILE_EXCL`, which causes the copy operation to fail if - * `dest` already exists. - */ - function copyFile(src: PathLike, dest: PathLike, flags?: number): Promise; - - /** - * Asynchronous open(2) - open and possibly create a file. - * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. - * @param mode A file mode. If a string is passed, it is parsed as an octal integer. If not - * supplied, defaults to `0o666`. - */ - function open(path: PathLike, flags: string | number, mode?: string | number): Promise; - - /** - * Asynchronously reads data from the file referenced by the supplied `FileHandle`. - * @param handle A `FileHandle`. - * @param buffer The buffer that the data will be written to. - * @param offset The offset in the buffer at which to start writing. - * @param length The number of bytes to read. - * @param position The offset from the beginning of the file from which data should be read. If - * `null`, data will be read from the current position. - */ - function read( - handle: FileHandle, - buffer: TBuffer, - offset?: number | null, - length?: number | null, - position?: number | null, - ): Promise<{ bytesRead: number, buffer: TBuffer }>; - - /** - * Asynchronously writes `buffer` to the file referenced by the supplied `FileHandle`. - * It is unsafe to call `fsPromises.write()` multiple times on the same file without waiting for the `Promise` - * to be resolved (or rejected). For this scenario, `fs.createWriteStream` is strongly recommended. - * @param handle A `FileHandle`. - * @param buffer The buffer that the data will be written to. - * @param offset The part of the buffer to be written. If not supplied, defaults to `0`. - * @param length The number of bytes to write. If not supplied, defaults to `buffer.length - offset`. - * @param position The offset from the beginning of the file where this data should be written. If not supplied, defaults to the current position. - */ - function write( - handle: FileHandle, - buffer: TBuffer, - offset?: number | null, - length?: number | null, position?: number | null): Promise<{ bytesWritten: number, buffer: TBuffer }>; - - /** - * Asynchronously writes `string` to the file referenced by the supplied `FileHandle`. - * It is unsafe to call `fsPromises.write()` multiple times on the same file without waiting for the `Promise` - * to be resolved (or rejected). For this scenario, `fs.createWriteStream` is strongly recommended. - * @param handle A `FileHandle`. - * @param string A string to write. If something other than a string is supplied it will be coerced to a string. - * @param position The offset from the beginning of the file where this data should be written. If not supplied, defaults to the current position. - * @param encoding The expected string encoding. - */ - function write(handle: FileHandle, string: any, position?: number | null, encoding?: string | null): Promise<{ bytesWritten: number, buffer: string }>; - - /** - * Asynchronous rename(2) - Change the name or location of a file or directory. - * @param oldPath A path to a file. If a URL is provided, it must use the `file:` protocol. - * URL support is _experimental_. - * @param newPath A path to a file. If a URL is provided, it must use the `file:` protocol. - * URL support is _experimental_. - */ - function rename(oldPath: PathLike, newPath: PathLike): Promise; - - /** - * Asynchronous truncate(2) - Truncate a file to a specified length. - * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. - * @param len If not specified, defaults to `0`. - */ - function truncate(path: PathLike, len?: number): Promise; - - /** - * Asynchronous ftruncate(2) - Truncate a file to a specified length. - * @param handle A `FileHandle`. - * @param len If not specified, defaults to `0`. - */ - function ftruncate(handle: FileHandle, len?: number): Promise; - - /** - * Asynchronous rmdir(2) - delete a directory. - * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. - */ - function rmdir(path: PathLike, options?: RmDirAsyncOptions): Promise; - - /** - * Asynchronous fdatasync(2) - synchronize a file's in-core state with storage device. - * @param handle A `FileHandle`. - */ - function fdatasync(handle: FileHandle): Promise; - - /** - * Asynchronous fsync(2) - synchronize a file's in-core state with the underlying storage device. - * @param handle A `FileHandle`. - */ - function fsync(handle: FileHandle): Promise; - - /** - * Asynchronous mkdir(2) - create a directory. - * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. - * @param options Either the file mode, or an object optionally specifying the file mode and whether parent folders - * should be created. If a string is passed, it is parsed as an octal integer. If not specified, defaults to `0o777`. - */ - function mkdir(path: PathLike, options?: number | string | MakeDirectoryOptions | null): Promise; - - /** - * Asynchronous readdir(3) - read a directory. - * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. - * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. - */ - function readdir(path: PathLike, options?: { encoding?: BufferEncoding | null; withFileTypes?: false } | BufferEncoding | null): Promise; - - /** - * Asynchronous readdir(3) - read a directory. - * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. - * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. - */ - function readdir(path: PathLike, options: { encoding: "buffer"; withFileTypes?: false } | "buffer"): Promise; - - /** - * Asynchronous readdir(3) - read a directory. - * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. - * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. - */ - function readdir(path: PathLike, options?: { encoding?: string | null; withFileTypes?: false } | string | null): Promise; - - /** - * Asynchronous readdir(3) - read a directory. - * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. - * @param options If called with `withFileTypes: true` the result data will be an array of Dirent. - */ - function readdir(path: PathLike, options: { encoding?: string | null; withFileTypes: true }): Promise; - - /** - * Asynchronous readlink(2) - read value of a symbolic link. - * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. - * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. - */ - function readlink(path: PathLike, options?: { encoding?: BufferEncoding | null } | BufferEncoding | null): Promise; - - /** - * Asynchronous readlink(2) - read value of a symbolic link. - * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. - * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. - */ - function readlink(path: PathLike, options: { encoding: "buffer" } | "buffer"): Promise; - - /** - * Asynchronous readlink(2) - read value of a symbolic link. - * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. - * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. - */ - function readlink(path: PathLike, options?: { encoding?: string | null } | string | null): Promise; - - /** - * Asynchronous symlink(2) - Create a new symbolic link to an existing file. - * @param target A path to an existing file. If a URL is provided, it must use the `file:` protocol. - * @param path A path to the new symlink. If a URL is provided, it must use the `file:` protocol. - * @param type May be set to `'dir'`, `'file'`, or `'junction'` (default is `'file'`) and is only available on Windows (ignored on other platforms). - * When using `'junction'`, the `target` argument will automatically be normalized to an absolute path. - */ - function symlink(target: PathLike, path: PathLike, type?: string | null): Promise; - - /** - * Asynchronous fstat(2) - Get file status. - * @param handle A `FileHandle`. - */ - function fstat(handle: FileHandle): Promise; - - /** - * Asynchronous lstat(2) - Get file status. Does not dereference symbolic links. - * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. - */ - function lstat(path: PathLike): Promise; - - /** - * Asynchronous stat(2) - Get file status. - * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. - */ - function stat(path: PathLike): Promise; - - /** - * Asynchronous link(2) - Create a new link (also known as a hard link) to an existing file. - * @param existingPath A path to a file. If a URL is provided, it must use the `file:` protocol. - * @param newPath A path to a file. If a URL is provided, it must use the `file:` protocol. - */ - function link(existingPath: PathLike, newPath: PathLike): Promise; - - /** - * Asynchronous unlink(2) - delete a name and possibly the file it refers to. - * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. - */ - function unlink(path: PathLike): Promise; - - /** - * Asynchronous fchmod(2) - Change permissions of a file. - * @param handle A `FileHandle`. - * @param mode A file mode. If a string is passed, it is parsed as an octal integer. - */ - function fchmod(handle: FileHandle, mode: string | number): Promise; - - /** - * Asynchronous chmod(2) - Change permissions of a file. - * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. - * @param mode A file mode. If a string is passed, it is parsed as an octal integer. - */ - function chmod(path: PathLike, mode: string | number): Promise; - - /** - * Asynchronous lchmod(2) - Change permissions of a file. Does not dereference symbolic links. - * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. - * @param mode A file mode. If a string is passed, it is parsed as an octal integer. - */ - function lchmod(path: PathLike, mode: string | number): Promise; - - /** - * Asynchronous lchown(2) - Change ownership of a file. Does not dereference symbolic links. - * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. - */ - function lchown(path: PathLike, uid: number, gid: number): Promise; - - /** - * Asynchronous fchown(2) - Change ownership of a file. - * @param handle A `FileHandle`. - */ - function fchown(handle: FileHandle, uid: number, gid: number): Promise; - - /** - * Asynchronous chown(2) - Change ownership of a file. - * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. - */ - function chown(path: PathLike, uid: number, gid: number): Promise; - - /** - * Asynchronously change file timestamps of the file referenced by the supplied path. - * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. - * @param atime The last access time. If a string is provided, it will be coerced to number. - * @param mtime The last modified time. If a string is provided, it will be coerced to number. - */ - function utimes(path: PathLike, atime: string | number | Date, mtime: string | number | Date): Promise; - - /** - * Asynchronously change file timestamps of the file referenced by the supplied `FileHandle`. - * @param handle A `FileHandle`. - * @param atime The last access time. If a string is provided, it will be coerced to number. - * @param mtime The last modified time. If a string is provided, it will be coerced to number. - */ - function futimes(handle: FileHandle, atime: string | number | Date, mtime: string | number | Date): Promise; - - /** - * Asynchronous realpath(3) - return the canonicalized absolute pathname. - * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. - * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. - */ - function realpath(path: PathLike, options?: { encoding?: BufferEncoding | null } | BufferEncoding | null): Promise; - - /** - * Asynchronous realpath(3) - return the canonicalized absolute pathname. - * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. - * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. - */ - function realpath(path: PathLike, options: { encoding: "buffer" } | "buffer"): Promise; - - /** - * Asynchronous realpath(3) - return the canonicalized absolute pathname. - * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. - * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. - */ - function realpath(path: PathLike, options?: { encoding?: string | null } | string | null): Promise; - - /** - * Asynchronously creates a unique temporary directory. - * Generates six random characters to be appended behind a required `prefix` to create a unique temporary directory. - * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. - */ - function mkdtemp(prefix: string, options?: { encoding?: BufferEncoding | null } | BufferEncoding | null): Promise; - - /** - * Asynchronously creates a unique temporary directory. - * Generates six random characters to be appended behind a required `prefix` to create a unique temporary directory. - * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. - */ - function mkdtemp(prefix: string, options: { encoding: "buffer" } | "buffer"): Promise; - - /** - * Asynchronously creates a unique temporary directory. - * Generates six random characters to be appended behind a required `prefix` to create a unique temporary directory. - * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. - */ - function mkdtemp(prefix: string, options?: { encoding?: string | null } | string | null): Promise; - - /** - * Asynchronously writes data to a file, replacing the file if it already exists. - * It is unsafe to call `fsPromises.writeFile()` multiple times on the same file without waiting for the `Promise` to be resolved (or rejected). - * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. - * URL support is _experimental_. - * If a `FileHandle` is provided, the underlying file will _not_ be closed automatically. - * @param data The data to write. If something other than a `Buffer` or `Uint8Array` is provided, the value is coerced to a string. - * @param options Either the encoding for the file, or an object optionally specifying the encoding, file mode, and flag. - * If `encoding` is not supplied, the default of `'utf8'` is used. - * If `mode` is not supplied, the default of `0o666` is used. - * If `mode` is a string, it is parsed as an octal integer. - * If `flag` is not supplied, the default of `'w'` is used. - */ - function writeFile(path: PathLike | FileHandle, data: any, options?: { encoding?: string | null, mode?: string | number, flag?: string | number } | string | null): Promise; - - /** - * Asynchronously append data to a file, creating the file if it does not exist. - * @param file A path to a file. If a URL is provided, it must use the `file:` protocol. - * URL support is _experimental_. - * If a `FileHandle` is provided, the underlying file will _not_ be closed automatically. - * @param data The data to write. If something other than a `Buffer` or `Uint8Array` is provided, the value is coerced to a string. - * @param options Either the encoding for the file, or an object optionally specifying the encoding, file mode, and flag. - * If `encoding` is not supplied, the default of `'utf8'` is used. - * If `mode` is not supplied, the default of `0o666` is used. - * If `mode` is a string, it is parsed as an octal integer. - * If `flag` is not supplied, the default of `'a'` is used. - */ - function appendFile(path: PathLike | FileHandle, data: any, options?: { encoding?: string | null, mode?: string | number, flag?: string | number } | string | null): Promise; - - /** - * Asynchronously reads the entire contents of a file. - * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. - * If a `FileHandle` is provided, the underlying file will _not_ be closed automatically. - * @param options An object that may contain an optional flag. - * If a flag is not provided, it defaults to `'r'`. - */ - function readFile(path: PathLike | FileHandle, options?: { encoding?: null, flag?: string | number } | null): Promise; - - /** - * Asynchronously reads the entire contents of a file. - * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. - * If a `FileHandle` is provided, the underlying file will _not_ be closed automatically. - * @param options An object that may contain an optional flag. - * If a flag is not provided, it defaults to `'r'`. - */ - function readFile(path: PathLike | FileHandle, options: { encoding: BufferEncoding, flag?: string | number } | BufferEncoding): Promise; - - /** - * Asynchronously reads the entire contents of a file. - * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. - * If a `FileHandle` is provided, the underlying file will _not_ be closed automatically. - * @param options An object that may contain an optional flag. - * If a flag is not provided, it defaults to `'r'`. - */ - function readFile(path: PathLike | FileHandle, options?: { encoding?: string | null, flag?: string | number } | string | null): Promise; - - function opendir(path: string, options?: OpenDirOptions): Promise; + export interface StatOptions { + bigint: boolean; } } diff --git a/node_modules/@types/node/globals.d.ts b/node_modules/@types/node/globals.d.ts index d9505f1..1241960 100644 --- a/node_modules/@types/node/globals.d.ts +++ b/node_modules/@types/node/globals.d.ts @@ -1,136 +1,7 @@ -// This needs to be global to avoid TS2403 in case lib.dom.d.ts is present in the same build -interface Console { - Console: NodeJS.ConsoleConstructor; - /** - * A simple assertion test that verifies whether `value` is truthy. - * If it is not, an `AssertionError` is thrown. - * If provided, the error `message` is formatted using `util.format()` and used as the error message. - */ - assert(value: any, message?: string, ...optionalParams: any[]): void; - /** - * When `stdout` is a TTY, calling `console.clear()` will attempt to clear the TTY. - * When `stdout` is not a TTY, this method does nothing. - */ - clear(): void; - /** - * Maintains an internal counter specific to `label` and outputs to `stdout` the number of times `console.count()` has been called with the given `label`. - */ - count(label?: string): void; - /** - * Resets the internal counter specific to `label`. - */ - countReset(label?: string): void; - /** - * The `console.debug()` function is an alias for {@link console.log()}. - */ - debug(message?: any, ...optionalParams: any[]): void; - /** - * Uses {@link util.inspect()} on `obj` and prints the resulting string to `stdout`. - * This function bypasses any custom `inspect()` function defined on `obj`. - */ - dir(obj: any, options?: NodeJS.InspectOptions): void; - /** - * This method calls {@link console.log()} passing it the arguments received. Please note that this method does not produce any XML formatting - */ - dirxml(...data: any[]): void; - /** - * Prints to `stderr` with newline. - */ - error(message?: any, ...optionalParams: any[]): void; - /** - * Increases indentation of subsequent lines by two spaces. - * If one or more `label`s are provided, those are printed first without the additional indentation. - */ - group(...label: any[]): void; - /** - * The `console.groupCollapsed()` function is an alias for {@link console.group()}. - */ - groupCollapsed(...label: any[]): void; - /** - * Decreases indentation of subsequent lines by two spaces. - */ - groupEnd(): void; - /** - * The {@link console.info()} function is an alias for {@link console.log()}. - */ - info(message?: any, ...optionalParams: any[]): void; - /** - * Prints to `stdout` with newline. - */ - log(message?: any, ...optionalParams: any[]): void; - /** - * This method does not display anything unless used in the inspector. - * Prints to `stdout` the array `array` formatted as a table. - */ - table(tabularData: any, properties?: string[]): void; - /** - * Starts a timer that can be used to compute the duration of an operation. Timers are identified by a unique `label`. - */ - time(label?: string): void; - /** - * Stops a timer that was previously started by calling {@link console.time()} and prints the result to `stdout`. - */ - timeEnd(label?: string): void; - /** - * For a timer that was previously started by calling {@link console.time()}, prints the elapsed time and other `data` arguments to `stdout`. - */ - timeLog(label?: string, ...data: any[]): void; - /** - * Prints to `stderr` the string 'Trace :', followed by the {@link util.format()} formatted message and stack trace to the current position in the code. - */ - trace(message?: any, ...optionalParams: any[]): void; - /** - * The {@link console.warn()} function is an alias for {@link console.error()}. - */ - warn(message?: any, ...optionalParams: any[]): void; - - // --- Inspector mode only --- - /** - * This method does not display anything unless used in the inspector. - * The console.markTimeline() method is the deprecated form of console.timeStamp(). - * - * @deprecated Use console.timeStamp() instead. - */ - markTimeline(label?: string): void; - /** - * This method does not display anything unless used in the inspector. - * Starts a JavaScript CPU profile with an optional label. - */ - profile(label?: string): void; - /** - * This method does not display anything unless used in the inspector. - * Stops the current JavaScript CPU profiling session if one has been started and prints the report to the Profiles panel of the inspector. - */ - profileEnd(label?: string): void; - /** - * This method does not display anything unless used in the inspector. - * Adds an event with the label `label` to the Timeline panel of the inspector. - */ - timeStamp(label?: string): void; - /** - * This method does not display anything unless used in the inspector. - * The console.timeline() method is the deprecated form of console.time(). - * - * @deprecated Use console.time() instead. - */ - timeline(label?: string): void; - /** - * This method does not display anything unless used in the inspector. - * The console.timelineEnd() method is the deprecated form of console.timeEnd(). - * - * @deprecated Use console.timeEnd() instead. - */ - timelineEnd(label?: string): void; -} - -interface Error { - stack?: string; -} - // Declare "static" methods in Error interface ErrorConstructor { /** Create .stack property on a target object */ - captureStackTrace(targetObject: Object, constructorOpt?: Function): void; + captureStackTrace(targetObject: object, constructorOpt?: Function): void; /** * Optional override for formatting stack traces @@ -142,16 +13,17 @@ interface ErrorConstructor { stackTraceLimit: number; } -interface SymbolConstructor { - readonly observable: symbol; -} - // Node.js ESNEXT support interface String { /** Removes whitespace from the left end of a string. */ trimLeft(): string; /** Removes whitespace from the right end of a string. */ trimRight(): string; + + /** Returns a copy with leading whitespace removed. */ + trimStart(): string; + /** Returns a copy with trailing whitespace removed. */ + trimEnd(): string; } interface ImportMeta { @@ -163,8 +35,13 @@ interface ImportMeta { * GLOBAL * * * ------------------------------------------------*/ + +// For backwards compability +interface NodeRequire extends NodeJS.Require {} +interface RequireResolve extends NodeJS.RequireResolve {} +interface NodeModule extends NodeJS.Module {} + declare var process: NodeJS.Process; -declare var global: NodeJS.Global; declare var console: Console; declare var __filename: string; @@ -187,51 +64,7 @@ declare function clearImmediate(immediateId: NodeJS.Immediate): void; declare function queueMicrotask(callback: () => void): void; -// TODO: change to `type NodeRequireFunction = (id: string) => any;` in next mayor version. -interface NodeRequireFunction { - /* tslint:disable-next-line:callable-types */ - (id: string): any; -} - -interface NodeRequireCache { - [path: string]: NodeModule; -} - -interface NodeRequire extends NodeRequireFunction { - resolve: RequireResolve; - cache: NodeRequireCache; - /** - * @deprecated - */ - extensions: NodeExtensions; - main: NodeModule | undefined; -} - -interface RequireResolve { - (id: string, options?: { paths?: string[]; }): string; - paths(request: string): string[] | null; -} - -interface NodeExtensions { - '.js': (m: NodeModule, filename: string) => any; - '.json': (m: NodeModule, filename: string) => any; - '.node': (m: NodeModule, filename: string) => any; - [ext: string]: (m: NodeModule, filename: string) => any; -} - declare var require: NodeRequire; - -interface NodeModule { - exports: any; - require: NodeRequireFunction; - id: string; - filename: string; - loaded: boolean; - parent: NodeModule | null; - children: NodeModule[]; - paths: string[]; -} - declare var module: NodeModule; // Same as module.exports @@ -240,10 +73,6 @@ declare var exports: any; // Buffer class type BufferEncoding = "ascii" | "utf8" | "utf-8" | "utf16le" | "ucs2" | "ucs-2" | "base64" | "latin1" | "binary" | "hex"; -interface Buffer { - constructor: typeof Buffer; -} - /** * Raw data is stored in instances of the Buffer class. * A Buffer is similar to an array of integers but corresponds to a raw memory allocation outside the V8 heap. A Buffer cannot be resized. @@ -287,7 +116,7 @@ declare class Buffer extends Uint8Array { * @param array The octets to store. * @deprecated since v10.0.0 - Use `Buffer.from(array)` instead. */ - constructor(array: any[]); + constructor(array: ReadonlyArray); /** * Copies the passed {buffer} data onto a new {Buffer} instance. * @@ -308,8 +137,14 @@ declare class Buffer extends Uint8Array { * Creates a new Buffer using the passed {data} * @param data data to create a new Buffer */ - static from(data: number[]): Buffer; + static from(data: ReadonlyArray): Buffer; static from(data: Uint8Array): Buffer; + /** + * Creates a new buffer containing the coerced value of an object + * A `TypeError` will be thrown if {obj} has not mentioned methods or is not of other type appropriate for `Buffer.from()` variants. + * @param obj An object supporting `Symbol.toPrimitive` or `valueOf()`. + */ + static from(obj: { valueOf(): string | object } | { [Symbol.toPrimitive](hint: 'string'): string }, byteOffset?: number, length?: number): Buffer; /** * Creates a new Buffer containing the given JavaScript string {str}. * If provided, the {encoding} parameter identifies the character encoding. @@ -356,7 +191,7 @@ declare class Buffer extends Uint8Array { * @param totalLength Total length of the buffers when concatenated. * If totalLength is not provided, it is read from the buffers in the list. However, this adds an additional loop to the function, so it is faster to provide the length explicitly. */ - static concat(list: Uint8Array[], totalLength?: number): Buffer; + static concat(list: ReadonlyArray, totalLength?: number): Buffer; /** * The same as buf1.compare(buf2). */ @@ -392,7 +227,7 @@ declare class Buffer extends Uint8Array { write(string: string, encoding?: BufferEncoding): number; write(string: string, offset: number, encoding?: BufferEncoding): number; write(string: string, offset: number, length: number, encoding?: BufferEncoding): number; - toString(encoding?: string, start?: number, end?: number): string; + toString(encoding?: BufferEncoding, start?: number, end?: number): string; toJSON(): { type: 'Buffer'; data: number[] }; equals(otherBuffer: Uint8Array): boolean; compare( @@ -421,46 +256,54 @@ declare class Buffer extends Uint8Array { * @param end Where the new `Buffer` will end (not inclusive). Default: `buf.length`. */ subarray(begin?: number, end?: number): Buffer; + writeBigInt64BE(value: bigint, offset?: number): number; + writeBigInt64LE(value: bigint, offset?: number): number; + writeBigUInt64BE(value: bigint, offset?: number): number; + writeBigUInt64LE(value: bigint, offset?: number): number; writeUIntLE(value: number, offset: number, byteLength: number): number; writeUIntBE(value: number, offset: number, byteLength: number): number; writeIntLE(value: number, offset: number, byteLength: number): number; writeIntBE(value: number, offset: number, byteLength: number): number; + readBigUInt64BE(offset?: number): bigint; + readBigUInt64LE(offset?: number): bigint; + readBigInt64BE(offset?: number): bigint; + readBigInt64LE(offset?: number): bigint; readUIntLE(offset: number, byteLength: number): number; readUIntBE(offset: number, byteLength: number): number; readIntLE(offset: number, byteLength: number): number; readIntBE(offset: number, byteLength: number): number; - readUInt8(offset: number): number; - readUInt16LE(offset: number): number; - readUInt16BE(offset: number): number; - readUInt32LE(offset: number): number; - readUInt32BE(offset: number): number; - readInt8(offset: number): number; - readInt16LE(offset: number): number; - readInt16BE(offset: number): number; - readInt32LE(offset: number): number; - readInt32BE(offset: number): number; - readFloatLE(offset: number): number; - readFloatBE(offset: number): number; - readDoubleLE(offset: number): number; - readDoubleBE(offset: number): number; + readUInt8(offset?: number): number; + readUInt16LE(offset?: number): number; + readUInt16BE(offset?: number): number; + readUInt32LE(offset?: number): number; + readUInt32BE(offset?: number): number; + readInt8(offset?: number): number; + readInt16LE(offset?: number): number; + readInt16BE(offset?: number): number; + readInt32LE(offset?: number): number; + readInt32BE(offset?: number): number; + readFloatLE(offset?: number): number; + readFloatBE(offset?: number): number; + readDoubleLE(offset?: number): number; + readDoubleBE(offset?: number): number; reverse(): this; swap16(): Buffer; swap32(): Buffer; swap64(): Buffer; - writeUInt8(value: number, offset: number): number; - writeUInt16LE(value: number, offset: number): number; - writeUInt16BE(value: number, offset: number): number; - writeUInt32LE(value: number, offset: number): number; - writeUInt32BE(value: number, offset: number): number; - writeInt8(value: number, offset: number): number; - writeInt16LE(value: number, offset: number): number; - writeInt16BE(value: number, offset: number): number; - writeInt32LE(value: number, offset: number): number; - writeInt32BE(value: number, offset: number): number; - writeFloatLE(value: number, offset: number): number; - writeFloatBE(value: number, offset: number): number; - writeDoubleLE(value: number, offset: number): number; - writeDoubleBE(value: number, offset: number): number; + writeUInt8(value: number, offset?: number): number; + writeUInt16LE(value: number, offset?: number): number; + writeUInt16BE(value: number, offset?: number): number; + writeUInt32LE(value: number, offset?: number): number; + writeUInt32BE(value: number, offset?: number): number; + writeInt8(value: number, offset?: number): number; + writeInt16LE(value: number, offset?: number): number; + writeInt16BE(value: number, offset?: number): number; + writeInt32LE(value: number, offset?: number): number; + writeInt32BE(value: number, offset?: number): number; + writeFloatLE(value: number, offset?: number): number; + writeFloatBE(value: number, offset?: number): number; + writeDoubleLE(value: number, offset?: number): number; + writeDoubleBE(value: number, offset?: number): number; fill(value: string | Uint8Array | number, offset?: number, end?: number, encoding?: BufferEncoding): this; @@ -497,6 +340,13 @@ declare namespace NodeJS { customInspect?: boolean; showProxy?: boolean; maxArrayLength?: number | null; + /** + * Specifies the maximum number of characters to + * include when formatting. Set to `null` or `Infinity` to show all elements. + * Set to `0` or negative to show no characters. + * @default Infinity + */ + maxStringLength?: number | null; breakLength?: number; /** * Setting this to `false` causes each object key @@ -512,20 +362,6 @@ declare namespace NodeJS { sorted?: boolean | ((a: string, b: string) => number); } - interface ConsoleConstructorOptions { - stdout: WritableStream; - stderr?: WritableStream; - ignoreErrors?: boolean; - colorMode?: boolean | 'auto'; - inspectOptions?: InspectOptions; - } - - interface ConsoleConstructor { - prototype: Console; - new(stdout: WritableStream, stderr?: WritableStream, ignoreErrors?: boolean): Console; - new(options: ConsoleConstructorOptions): Console; - } - interface CallSite { /** * Value of "this" @@ -608,29 +444,10 @@ declare namespace NodeJS { stack?: string; } - class EventEmitter { - addListener(event: string | symbol, listener: (...args: any[]) => void): this; - on(event: string | symbol, listener: (...args: any[]) => void): this; - once(event: string | symbol, listener: (...args: any[]) => void): this; - removeListener(event: string | symbol, listener: (...args: any[]) => void): this; - off(event: string | symbol, listener: (...args: any[]) => void): this; - removeAllListeners(event?: string | symbol): this; - setMaxListeners(n: number): this; - getMaxListeners(): number; - listeners(event: string | symbol): Function[]; - rawListeners(event: string | symbol): Function[]; - emit(event: string | symbol, ...args: any[]): boolean; - listenerCount(type: string | symbol): number; - // Added in Node 6... - prependListener(event: string | symbol, listener: (...args: any[]) => void): this; - prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this; - eventNames(): Array; - } - interface ReadableStream extends EventEmitter { readable: boolean; read(size?: number): string | Buffer; - setEncoding(encoding: string): this; + setEncoding(encoding: BufferEncoding): this; pause(): this; resume(): this; isPaused(): boolean; @@ -644,404 +461,14 @@ declare namespace NodeJS { interface WritableStream extends EventEmitter { writable: boolean; write(buffer: Uint8Array | string, cb?: (err?: Error | null) => void): boolean; - write(str: string, encoding?: string, cb?: (err?: Error | null) => void): boolean; + write(str: string, encoding?: BufferEncoding, cb?: (err?: Error | null) => void): boolean; end(cb?: () => void): void; end(data: string | Uint8Array, cb?: () => void): void; - end(str: string, encoding?: string, cb?: () => void): void; + end(str: string, encoding?: BufferEncoding, cb?: () => void): void; } interface ReadWriteStream extends ReadableStream, WritableStream { } - interface Domain extends EventEmitter { - run(fn: (...args: any[]) => T, ...args: any[]): T; - add(emitter: EventEmitter | Timer): void; - remove(emitter: EventEmitter | Timer): void; - bind(cb: T): T; - intercept(cb: T): T; - - addListener(event: string, listener: (...args: any[]) => void): this; - on(event: string, listener: (...args: any[]) => void): this; - once(event: string, listener: (...args: any[]) => void): this; - removeListener(event: string, listener: (...args: any[]) => void): this; - removeAllListeners(event?: string): this; - } - - interface MemoryUsage { - rss: number; - heapTotal: number; - heapUsed: number; - external: number; - } - - interface CpuUsage { - user: number; - system: number; - } - - interface ProcessRelease { - name: string; - sourceUrl?: string; - headersUrl?: string; - libUrl?: string; - lts?: string; - } - - interface ProcessVersions { - http_parser: string; - node: string; - v8: string; - ares: string; - uv: string; - zlib: string; - modules: string; - openssl: string; - } - - type Platform = 'aix' - | 'android' - | 'darwin' - | 'freebsd' - | 'linux' - | 'openbsd' - | 'sunos' - | 'win32' - | 'cygwin' - | 'netbsd'; - - type Signals = - "SIGABRT" | "SIGALRM" | "SIGBUS" | "SIGCHLD" | "SIGCONT" | "SIGFPE" | "SIGHUP" | "SIGILL" | "SIGINT" | "SIGIO" | - "SIGIOT" | "SIGKILL" | "SIGPIPE" | "SIGPOLL" | "SIGPROF" | "SIGPWR" | "SIGQUIT" | "SIGSEGV" | "SIGSTKFLT" | - "SIGSTOP" | "SIGSYS" | "SIGTERM" | "SIGTRAP" | "SIGTSTP" | "SIGTTIN" | "SIGTTOU" | "SIGUNUSED" | "SIGURG" | - "SIGUSR1" | "SIGUSR2" | "SIGVTALRM" | "SIGWINCH" | "SIGXCPU" | "SIGXFSZ" | "SIGBREAK" | "SIGLOST" | "SIGINFO"; - - type MultipleResolveType = 'resolve' | 'reject'; - - type BeforeExitListener = (code: number) => void; - type DisconnectListener = () => void; - type ExitListener = (code: number) => void; - type RejectionHandledListener = (promise: Promise) => void; - type UncaughtExceptionListener = (error: Error) => void; - type UnhandledRejectionListener = (reason: {} | null | undefined, promise: Promise) => void; - type WarningListener = (warning: Error) => void; - type MessageListener = (message: any, sendHandle: any) => void; - type SignalsListener = (signal: Signals) => void; - type NewListenerListener = (type: string | symbol, listener: (...args: any[]) => void) => void; - type RemoveListenerListener = (type: string | symbol, listener: (...args: any[]) => void) => void; - type MultipleResolveListener = (type: MultipleResolveType, promise: Promise, value: any) => void; - - interface Socket extends ReadWriteStream { - isTTY?: true; - } - - interface ProcessEnv { - [key: string]: string | undefined; - } - - interface HRTime { - (time?: [number, number]): [number, number]; - } - - interface ProcessReport { - /** - * Directory where the report is written. - * working directory of the Node.js process. - * @default '' indicating that reports are written to the current - */ - directory: string; - - /** - * Filename where the report is written. - * The default value is the empty string. - * @default '' the output filename will be comprised of a timestamp, - * PID, and sequence number. - */ - filename: string; - - /** - * Returns a JSON-formatted diagnostic report for the running process. - * The report's JavaScript stack trace is taken from err, if present. - */ - getReport(err?: Error): string; - - /** - * If true, a diagnostic report is generated on fatal errors, - * such as out of memory errors or failed C++ assertions. - * @default false - */ - reportOnFatalError: boolean; - - /** - * If true, a diagnostic report is generated when the process - * receives the signal specified by process.report.signal. - * @defaul false - */ - reportOnSignal: boolean; - - /** - * If true, a diagnostic report is generated on uncaught exception. - * @default false - */ - reportOnUncaughtException: boolean; - - /** - * The signal used to trigger the creation of a diagnostic report. - * @default 'SIGUSR2' - */ - signal: Signals; - - /** - * Writes a diagnostic report to a file. If filename is not provided, the default filename - * includes the date, time, PID, and a sequence number. - * The report's JavaScript stack trace is taken from err, if present. - * - * @param fileName Name of the file where the report is written. - * This should be a relative path, that will be appended to the directory specified in - * `process.report.directory`, or the current working directory of the Node.js process, - * if unspecified. - * @param error A custom error used for reporting the JavaScript stack. - * @return Filename of the generated report. - */ - writeReport(fileName?: string): string; - writeReport(error?: Error): string; - writeReport(fileName?: string, err?: Error): string; - } - - interface ResourceUsage { - fsRead: number; - fsWrite: number; - involuntaryContextSwitches: number; - ipcReceived: number; - ipcSent: number; - majorPageFault: number; - maxRSS: number; - minorPageFault: number; - sharedMemorySize: number; - signalsCount: number; - swappedOut: number; - systemCPUTime: number; - unsharedDataSize: number; - unsharedStackSize: number; - userCPUTime: number; - voluntaryContextSwitches: number; - } - - interface Process extends EventEmitter { - /** - * Can also be a tty.WriteStream, not typed due to limitation.s - */ - stdout: WriteStream; - /** - * Can also be a tty.WriteStream, not typed due to limitation.s - */ - stderr: WriteStream; - stdin: ReadStream; - openStdin(): Socket; - argv: string[]; - argv0: string; - execArgv: string[]; - execPath: string; - abort(): void; - chdir(directory: string): void; - cwd(): string; - debugPort: number; - emitWarning(warning: string | Error, name?: string, ctor?: Function): void; - env: ProcessEnv; - exit(code?: number): never; - exitCode?: number; - getgid(): number; - setgid(id: number | string): void; - getuid(): number; - setuid(id: number | string): void; - geteuid(): number; - seteuid(id: number | string): void; - getegid(): number; - setegid(id: number | string): void; - getgroups(): number[]; - setgroups(groups: Array): void; - setUncaughtExceptionCaptureCallback(cb: ((err: Error) => void) | null): void; - hasUncaughtExceptionCaptureCallback(): boolean; - version: string; - versions: ProcessVersions; - config: { - target_defaults: { - cflags: any[]; - default_configuration: string; - defines: string[]; - include_dirs: string[]; - libraries: string[]; - }; - variables: { - clang: number; - host_arch: string; - node_install_npm: boolean; - node_install_waf: boolean; - node_prefix: string; - node_shared_openssl: boolean; - node_shared_v8: boolean; - node_shared_zlib: boolean; - node_use_dtrace: boolean; - node_use_etw: boolean; - node_use_openssl: boolean; - target_arch: string; - v8_no_strict_aliasing: number; - v8_use_snapshot: boolean; - visibility: string; - }; - }; - kill(pid: number, signal?: string | number): void; - pid: number; - ppid: number; - title: string; - arch: string; - platform: Platform; - mainModule?: NodeModule; - memoryUsage(): MemoryUsage; - cpuUsage(previousValue?: CpuUsage): CpuUsage; - nextTick(callback: Function, ...args: any[]): void; - release: ProcessRelease; - features: { - inspector: boolean; - debug: boolean; - uv: boolean; - ipv6: boolean; - tls_alpn: boolean; - tls_sni: boolean; - tls_ocsp: boolean; - tls: boolean; - }; - /** - * Can only be set if not in worker thread. - */ - umask(mask?: number): number; - uptime(): number; - hrtime: HRTime; - domain: Domain; - - // Worker - send?(message: any, sendHandle?: any, options?: { swallowErrors?: boolean}, callback?: (error: Error | null) => void): boolean; - disconnect(): void; - connected: boolean; - - /** - * The `process.allowedNodeEnvironmentFlags` property is a special, - * read-only `Set` of flags allowable within the [`NODE_OPTIONS`][] - * environment variable. - */ - allowedNodeEnvironmentFlags: ReadonlySet; - - /** - * Only available with `--experimental-report` - */ - report?: ProcessReport; - - resourceUsage(): ResourceUsage; - - /** - * EventEmitter - * 1. beforeExit - * 2. disconnect - * 3. exit - * 4. message - * 5. rejectionHandled - * 6. uncaughtException - * 7. unhandledRejection - * 8. warning - * 9. message - * 10. - * 11. newListener/removeListener inherited from EventEmitter - */ - addListener(event: "beforeExit", listener: BeforeExitListener): this; - addListener(event: "disconnect", listener: DisconnectListener): this; - addListener(event: "exit", listener: ExitListener): this; - addListener(event: "rejectionHandled", listener: RejectionHandledListener): this; - addListener(event: "uncaughtException", listener: UncaughtExceptionListener): this; - addListener(event: "unhandledRejection", listener: UnhandledRejectionListener): this; - addListener(event: "warning", listener: WarningListener): this; - addListener(event: "message", listener: MessageListener): this; - addListener(event: Signals, listener: SignalsListener): this; - addListener(event: "newListener", listener: NewListenerListener): this; - addListener(event: "removeListener", listener: RemoveListenerListener): this; - addListener(event: "multipleResolves", listener: MultipleResolveListener): this; - - emit(event: "beforeExit", code: number): boolean; - emit(event: "disconnect"): boolean; - emit(event: "exit", code: number): boolean; - emit(event: "rejectionHandled", promise: Promise): boolean; - emit(event: "uncaughtException", error: Error): boolean; - emit(event: "unhandledRejection", reason: any, promise: Promise): boolean; - emit(event: "warning", warning: Error): boolean; - emit(event: "message", message: any, sendHandle: any): this; - emit(event: Signals, signal: Signals): boolean; - emit(event: "newListener", eventName: string | symbol, listener: (...args: any[]) => void): this; - emit(event: "removeListener", eventName: string, listener: (...args: any[]) => void): this; - emit(event: "multipleResolves", listener: MultipleResolveListener): this; - - on(event: "beforeExit", listener: BeforeExitListener): this; - on(event: "disconnect", listener: DisconnectListener): this; - on(event: "exit", listener: ExitListener): this; - on(event: "rejectionHandled", listener: RejectionHandledListener): this; - on(event: "uncaughtException", listener: UncaughtExceptionListener): this; - on(event: "unhandledRejection", listener: UnhandledRejectionListener): this; - on(event: "warning", listener: WarningListener): this; - on(event: "message", listener: MessageListener): this; - on(event: Signals, listener: SignalsListener): this; - on(event: "newListener", listener: NewListenerListener): this; - on(event: "removeListener", listener: RemoveListenerListener): this; - on(event: "multipleResolves", listener: MultipleResolveListener): this; - - once(event: "beforeExit", listener: BeforeExitListener): this; - once(event: "disconnect", listener: DisconnectListener): this; - once(event: "exit", listener: ExitListener): this; - once(event: "rejectionHandled", listener: RejectionHandledListener): this; - once(event: "uncaughtException", listener: UncaughtExceptionListener): this; - once(event: "unhandledRejection", listener: UnhandledRejectionListener): this; - once(event: "warning", listener: WarningListener): this; - once(event: "message", listener: MessageListener): this; - once(event: Signals, listener: SignalsListener): this; - once(event: "newListener", listener: NewListenerListener): this; - once(event: "removeListener", listener: RemoveListenerListener): this; - once(event: "multipleResolves", listener: MultipleResolveListener): this; - - prependListener(event: "beforeExit", listener: BeforeExitListener): this; - prependListener(event: "disconnect", listener: DisconnectListener): this; - prependListener(event: "exit", listener: ExitListener): this; - prependListener(event: "rejectionHandled", listener: RejectionHandledListener): this; - prependListener(event: "uncaughtException", listener: UncaughtExceptionListener): this; - prependListener(event: "unhandledRejection", listener: UnhandledRejectionListener): this; - prependListener(event: "warning", listener: WarningListener): this; - prependListener(event: "message", listener: MessageListener): this; - prependListener(event: Signals, listener: SignalsListener): this; - prependListener(event: "newListener", listener: NewListenerListener): this; - prependListener(event: "removeListener", listener: RemoveListenerListener): this; - prependListener(event: "multipleResolves", listener: MultipleResolveListener): this; - - prependOnceListener(event: "beforeExit", listener: BeforeExitListener): this; - prependOnceListener(event: "disconnect", listener: DisconnectListener): this; - prependOnceListener(event: "exit", listener: ExitListener): this; - prependOnceListener(event: "rejectionHandled", listener: RejectionHandledListener): this; - prependOnceListener(event: "uncaughtException", listener: UncaughtExceptionListener): this; - prependOnceListener(event: "unhandledRejection", listener: UnhandledRejectionListener): this; - prependOnceListener(event: "warning", listener: WarningListener): this; - prependOnceListener(event: "message", listener: MessageListener): this; - prependOnceListener(event: Signals, listener: SignalsListener): this; - prependOnceListener(event: "newListener", listener: NewListenerListener): this; - prependOnceListener(event: "removeListener", listener: RemoveListenerListener): this; - prependOnceListener(event: "multipleResolves", listener: MultipleResolveListener): this; - - listeners(event: "beforeExit"): BeforeExitListener[]; - listeners(event: "disconnect"): DisconnectListener[]; - listeners(event: "exit"): ExitListener[]; - listeners(event: "rejectionHandled"): RejectionHandledListener[]; - listeners(event: "uncaughtException"): UncaughtExceptionListener[]; - listeners(event: "unhandledRejection"): UnhandledRejectionListener[]; - listeners(event: "warning"): WarningListener[]; - listeners(event: "message"): MessageListener[]; - listeners(event: Signals): SignalsListener[]; - listeners(event: "newListener"): NewListenerListener[]; - listeners(event: "removeListener"): RemoveListenerListener[]; - listeners(event: "multipleResolves"): MultipleResolveListener[]; - } - interface Global { Array: typeof Array; ArrayBuffer: typeof ArrayBuffer; @@ -1054,7 +481,6 @@ declare namespace NodeJS { Float32Array: typeof Float32Array; Float64Array: typeof Float64Array; Function: typeof Function; - GLOBAL: Global; Infinity: typeof Infinity; Int16Array: typeof Int16Array; Int32Array: typeof Int32Array; @@ -1066,7 +492,7 @@ declare namespace NodeJS { NaN: typeof NaN; Number: typeof Number; Object: typeof Object; - Promise: Function; + Promise: typeof Promise; RangeError: typeof RangeError; ReferenceError: typeof ReferenceError; RegExp: typeof RegExp; @@ -1079,13 +505,12 @@ declare namespace NodeJS { Uint16Array: typeof Uint16Array; Uint32Array: typeof Uint32Array; Uint8Array: typeof Uint8Array; - Uint8ClampedArray: Function; + Uint8ClampedArray: typeof Uint8ClampedArray; WeakMap: WeakMapConstructor; WeakSet: WeakSetConstructor; clearImmediate: (immediateId: Immediate) => void; clearInterval: (intervalId: Timeout) => void; clearTimeout: (timeoutId: Timeout) => void; - console: typeof console; decodeURI: typeof decodeURI; decodeURIComponent: typeof decodeURIComponent; encodeURI: typeof encodeURI; @@ -1097,8 +522,6 @@ declare namespace NodeJS { isNaN: typeof isNaN; parseFloat: typeof parseFloat; parseInt: typeof parseInt; - process: Process; - root: Global; setImmediate: (callback: (...args: any[]) => void, ...args: any[]) => Immediate; setInterval: (callback: (...args: any[]) => void, ms: number, ...args: any[]) => Timeout; setTimeout: (callback: (...args: any[]) => void, ms: number, ...args: any[]) => Timeout; @@ -1109,57 +532,76 @@ declare namespace NodeJS { v8debug?: any; } - // compatibility with older typings - interface Timer { - hasRef(): boolean; + interface RefCounted { ref(): this; - refresh(): this; unref(): this; } - class Immediate { + // compatibility with older typings + interface Timer extends RefCounted { + hasRef(): boolean; + refresh(): this; + [Symbol.toPrimitive](): number; + } + + interface Immediate extends RefCounted { hasRef(): boolean; - ref(): this; - unref(): this; _onImmediate: Function; // to distinguish it from the Timeout class } - class Timeout implements Timer { + interface Timeout extends Timer { hasRef(): boolean; - ref(): this; refresh(): this; - unref(): this; - } - - class Module { - static runMain(): void; - static wrap(code: string): string; - - /** - * @deprecated Deprecated since: v12.2.0. Please use createRequire() instead. - */ - static createRequireFromPath(path: string): NodeRequire; - static createRequire(path: string): NodeRequire; - static builtinModules: string[]; - - static Module: typeof Module; - - exports: any; - require: NodeRequireFunction; - id: string; - filename: string; - loaded: boolean; - parent: Module | null; - children: Module[]; - paths: string[]; - - constructor(id: string, parent?: Module); + [Symbol.toPrimitive](): number; } type TypedArray = Uint8Array | Uint8ClampedArray | Uint16Array | Uint32Array | Int8Array | Int16Array | Int32Array | Float32Array | Float64Array; type ArrayBufferView = TypedArray | DataView; - // The value type here is a "poor man's `unknown`". When these types support TypeScript - // 3.0+, we can replace this with `unknown`. - type PoorMansUnknown = {} | null | undefined; + interface Require { + (id: string): any; + resolve: RequireResolve; + cache: Dict; + /** + * @deprecated + */ + extensions: RequireExtensions; + main: Module | undefined; + } + + interface RequireResolve { + (id: string, options?: { paths?: string[]; }): string; + paths(request: string): string[] | null; + } + + interface RequireExtensions extends Dict<(m: Module, filename: string) => any> { + '.js': (m: Module, filename: string) => any; + '.json': (m: Module, filename: string) => any; + '.node': (m: Module, filename: string) => any; + } + interface Module { + exports: any; + require: Require; + id: string; + filename: string; + loaded: boolean; + /** @deprecated since 14.6.0 Please use `require.main` and `module.children` instead. */ + parent: Module | null | undefined; + children: Module[]; + /** + * @since 11.14.0 + * + * The directory name of the module. This is usually the same as the path.dirname() of the module.id. + */ + path: string; + paths: string[]; + } + + interface Dict { + [key: string]: T | undefined; + } + + interface ReadOnlyDict { + readonly [key: string]: T | undefined; + } } diff --git a/node_modules/@types/node/http.d.ts b/node_modules/@types/node/http.d.ts index 65ea677..72a478a 100644 --- a/node_modules/@types/node/http.d.ts +++ b/node_modules/@types/node/http.d.ts @@ -1,11 +1,10 @@ declare module "http" { - import * as events from "events"; import * as stream from "stream"; import { URL } from "url"; import { Socket, Server as NetServer } from "net"; // incoming headers will never contain number - interface IncomingHttpHeaders { + interface IncomingHttpHeaders extends NodeJS.Dict { 'accept'?: string; 'accept-language'?: string; 'accept-patch'?: string; @@ -16,6 +15,8 @@ declare module "http" { 'access-control-allow-origin'?: string; 'access-control-expose-headers'?: string; 'access-control-max-age'?: string; + 'access-control-request-headers'?: string; + 'access-control-request-method'?: string; 'age'?: string; 'allow'?: string; 'alt-svc'?: string; @@ -42,6 +43,7 @@ declare module "http" { 'if-unmodified-since'?: string; 'last-modified'?: string; 'location'?: string; + 'origin'?: string; 'pragma'?: string; 'proxy-authenticate'?: string; 'proxy-authorization'?: string; @@ -49,6 +51,11 @@ declare module "http" { 'range'?: string; 'referer'?: string; 'retry-after'?: string; + 'sec-websocket-accept'?: string; + 'sec-websocket-extensions'?: string; + 'sec-websocket-key'?: string; + 'sec-websocket-protocol'?: string; + 'sec-websocket-version'?: string; 'set-cookie'?: string[]; 'strict-transport-security'?: string; 'tk'?: string; @@ -60,12 +67,12 @@ declare module "http" { 'via'?: string; 'warning'?: string; 'www-authenticate'?: string; - [header: string]: string | string[] | undefined; } // outgoing headers allows numbers (as they are converted internally to strings) - interface OutgoingHttpHeaders { - [header: string]: number | string | string[] | undefined; + type OutgoingHttpHeader = number | string | string[]; + + interface OutgoingHttpHeaders extends NodeJS.Dict { } interface ClientRequestArgs { @@ -77,6 +84,10 @@ declare module "http" { defaultPort?: number | string; localAddress?: string; socketPath?: string; + /** + * @default 8192 + */ + maxHeaderSize?: number; method?: string; path?: string | null; headers?: OutgoingHttpHeaders; @@ -92,14 +103,25 @@ declare module "http" { interface ServerOptions { IncomingMessage?: typeof IncomingMessage; ServerResponse?: typeof ServerResponse; + /** + * Optionally overrides the value of + * [`--max-http-header-size`][] for requests received by this server, i.e. + * the maximum length of request headers in bytes. + * @default 8192 + */ + maxHeaderSize?: number; + /** + * Use an insecure HTTP parser that accepts invalid HTTP headers when true. + * Using the insecure parser should be avoided. + * See --insecure-http-parser for more information. + * @default false + */ + insecureHTTPParser?: boolean; } type RequestListener = (req: IncomingMessage, res: ServerResponse) => void; - class Server extends NetServer { - constructor(requestListener?: RequestListener); - constructor(options: ServerOptions, requestListener?: RequestListener); - + interface HttpBase { setTimeout(msecs?: number, callback?: () => void): this; setTimeout(callback: () => void): this; /** @@ -111,11 +133,23 @@ declare module "http" { timeout: number; /** * Limit the amount of time the parser will wait to receive the complete HTTP headers. - * @default 40000 + * @default 60000 * {@link https://nodejs.org/api/http.html#http_server_headerstimeout} */ headersTimeout: number; keepAliveTimeout: number; + /** + * Sets the timeout value in milliseconds for receiving the entire request from the client. + * @default 0 + * {@link https://nodejs.org/api/http.html#http_server_requesttimeout} + */ + requestTimeout: number; + } + + interface Server extends HttpBase {} + class Server extends NetServer { + constructor(requestListener?: RequestListener); + constructor(options: ServerOptions, requestListener?: RequestListener); } // https://github.com/nodejs/node/blob/master/lib/_http_outgoing.js @@ -125,20 +159,27 @@ declare module "http" { shouldKeepAlive: boolean; useChunkedEncodingByDefault: boolean; sendDate: boolean; + /** + * @deprecated Use `writableEnded` instead. + */ finished: boolean; headersSent: boolean; - connection: Socket; + /** + * @deprecate Use `socket` instead. + */ + connection: Socket | null; + socket: Socket | null; constructor(); setTimeout(msecs: number, callback?: () => void): this; - setHeader(name: string, value: number | string | string[]): void; + setHeader(name: string, value: number | string | ReadonlyArray): void; getHeader(name: string): number | string | string[] | undefined; getHeaders(): OutgoingHttpHeaders; getHeaderNames(): string[]; hasHeader(name: string): boolean; removeHeader(name: string): void; - addTrailers(headers: OutgoingHttpHeaders | Array<[string, string]>): void; + addTrailers(headers: OutgoingHttpHeaders | ReadonlyArray<[string, string]>): void; flushHeaders(): void; } @@ -146,7 +187,6 @@ declare module "http" { class ServerResponse extends OutgoingMessage { statusCode: number; statusMessage: string; - writableFinished: boolean; constructor(req: IncomingMessage); @@ -155,8 +195,9 @@ declare module "http" { // https://github.com/nodejs/node/blob/master/test/parallel/test-http-write-callbacks.js#L53 // no args in writeContinue callback writeContinue(callback?: () => void): void; - writeHead(statusCode: number, reasonPhrase?: string, headers?: OutgoingHttpHeaders): this; - writeHead(statusCode: number, headers?: OutgoingHttpHeaders): this; + writeHead(statusCode: number, reasonPhrase?: string, headers?: OutgoingHttpHeaders | OutgoingHttpHeader[]): this; + writeHead(statusCode: number, headers?: OutgoingHttpHeaders | OutgoingHttpHeader[]): this; + writeProcessing(): void; } interface InformationEvent { @@ -171,13 +212,14 @@ declare module "http" { // https://github.com/nodejs/node/blob/master/lib/_http_client.js#L77 class ClientRequest extends OutgoingMessage { - connection: Socket; - socket: Socket; - aborted: number; + aborted: boolean; + host: string; + protocol: string; constructor(url: string | URL | ClientRequestArgs, cb?: (res: IncomingMessage) => void); - readonly path: string; + method: string; + path: string; abort(): void; onSocket(socket: Socket): void; setTimeout(timeout: number, callback?: () => void): this; @@ -268,14 +310,19 @@ declare module "http" { class IncomingMessage extends stream.Readable { constructor(socket: Socket); + aborted: boolean; httpVersion: string; httpVersionMajor: number; httpVersionMinor: number; complete: boolean; + /** + * @deprecate Use `socket` instead. + */ connection: Socket; + socket: Socket; headers: IncomingHttpHeaders; rawHeaders: string[]; - trailers: { [key: string]: string | undefined }; + trailers: NodeJS.Dict; rawTrailers: string[]; setTimeout(msecs: number, callback?: () => void): this; /** @@ -294,7 +341,6 @@ declare module "http" { * Only valid for response obtained from http.ClientRequest. */ statusMessage?: string; - socket: Socket; destroy(error?: Error): void; } @@ -312,6 +358,10 @@ declare module "http" { * Maximum number of sockets to allow per host. Default for Node 0.10 is 5, default for Node 0.12 is Infinity */ maxSockets?: number; + /** + * Maximum number of sockets allowed for all hosts in total. Each request will use a new socket until the maximum is reached. Default: Infinity. + */ + maxTotalSockets?: number; /** * Maximum number of sockets to leave open in a free state. Only relevant if keepAlive is set to true. Default = 256. */ @@ -320,17 +370,19 @@ declare module "http" { * Socket timeout in milliseconds. This will set the timeout after the socket is connected. */ timeout?: number; + /** + * Scheduling strategy to apply when picking the next free socket to use. Default: 'fifo'. + */ + scheduling?: 'fifo' | 'lifo'; } class Agent { maxFreeSockets: number; maxSockets: number; - readonly sockets: { - readonly [key: string]: Socket[]; - }; - readonly requests: { - readonly [key: string]: IncomingMessage[]; - }; + maxTotalSockets: number; + readonly freeSockets: NodeJS.ReadOnlyDict; + readonly sockets: NodeJS.ReadOnlyDict; + readonly requests: NodeJS.ReadOnlyDict; constructor(opts?: AgentOptions); @@ -364,7 +416,7 @@ declare module "http" { /** * Read-only property specifying the maximum allowed size of HTTP headers in bytes. - * Defaults to 8KB. Configurable using the [`--max-http-header-size`][] CLI option. + * Defaults to 16KB. Configurable using the [`--max-http-header-size`][] CLI option. */ const maxHeaderSize: number; } diff --git a/node_modules/@types/node/http2.d.ts b/node_modules/@types/node/http2.d.ts index 8c16e10..0788293 100644 --- a/node_modules/@types/node/http2.d.ts +++ b/node_modules/@types/node/http2.d.ts @@ -356,7 +356,7 @@ declare module "http2" { addListener(event: string | symbol, listener: (...args: any[]) => void): this; emit(event: "altsvc", alt: string, origin: string, stream: number): boolean; - emit(event: "origin", origins: string[]): boolean; + emit(event: "origin", origins: ReadonlyArray): boolean; emit(event: "connect", session: ClientHttp2Session, socket: net.Socket | tls.TLSSocket): boolean; emit(event: "stream", stream: ClientHttp2Stream, headers: IncomingHttpHeaders & IncomingHttpStatusHeader, flags: number): boolean; emit(event: string | symbol, ...args: any[]): boolean; @@ -440,6 +440,7 @@ declare module "http2" { export interface ClientSessionOptions extends SessionOptions { maxReservedRemoteStreams?: number; createConnection?: (authority: url.URL, option: SessionOptions) => stream.Duplex; + protocol?: 'http:' | 'https:'; } export interface ServerSessionOptions extends SessionOptions { @@ -570,12 +571,16 @@ declare module "http2" { } export class Http2ServerRequest extends stream.Readable { - constructor(stream: ServerHttp2Stream, headers: IncomingHttpHeaders, options: stream.ReadableOptions, rawHeaders: string[]); + constructor(stream: ServerHttp2Stream, headers: IncomingHttpHeaders, options: stream.ReadableOptions, rawHeaders: ReadonlyArray); readonly aborted: boolean; readonly authority: string; + readonly connection: net.Socket | tls.TLSSocket; + readonly complete: boolean; readonly headers: IncomingHttpHeaders; readonly httpVersion: string; + readonly httpVersionMinor: number; + readonly httpVersionMajor: number; readonly method: string; readonly rawHeaders: string[]; readonly rawTrailers: string[]; @@ -651,16 +656,16 @@ declare module "http2" { addTrailers(trailers: OutgoingHttpHeaders): void; end(callback?: () => void): void; end(data: string | Uint8Array, callback?: () => void): void; - end(data: string | Uint8Array, encoding: string, callback?: () => void): void; + end(data: string | Uint8Array, encoding: BufferEncoding, callback?: () => void): void; getHeader(name: string): string; getHeaderNames(): string[]; getHeaders(): OutgoingHttpHeaders; hasHeader(name: string): boolean; removeHeader(name: string): void; - setHeader(name: string, value: number | string | string[]): void; + setHeader(name: string, value: number | string | ReadonlyArray): void; setTimeout(msecs: number, callback?: () => void): void; write(chunk: string | Uint8Array, callback?: (err: Error) => void): boolean; - write(chunk: string | Uint8Array, encoding: string, callback?: (err: Error) => void): boolean; + write(chunk: string | Uint8Array, encoding: BufferEncoding, callback?: (err: Error) => void): boolean; writeContinue(): void; writeHead(statusCode: number, headers?: OutgoingHttpHeaders): this; writeHead(statusCode: number, statusMessage: string, headers?: OutgoingHttpHeaders): this; diff --git a/node_modules/@types/node/https.d.ts b/node_modules/@types/node/https.d.ts index 6f33dbd..24326c9 100644 --- a/node_modules/@types/node/https.d.ts +++ b/node_modules/@types/node/https.d.ts @@ -21,26 +21,10 @@ declare module "https" { options: AgentOptions; } + interface Server extends http.HttpBase {} class Server extends tls.Server { constructor(requestListener?: http.RequestListener); constructor(options: ServerOptions, requestListener?: http.RequestListener); - - setTimeout(callback: () => void): this; - setTimeout(msecs?: number, callback?: () => void): this; - /** - * Limits maximum incoming headers count. If set to 0, no limit will be applied. - * @default 2000 - * {@link https://nodejs.org/api/http.html#http_server_maxheaderscount} - */ - maxHeadersCount: number | null; - timeout: number; - /** - * Limit the amount of time the parser will wait to receive the complete HTTP headers. - * @default 40000 - * {@link https://nodejs.org/api/http.html#http_server_headerstimeout} - */ - headersTimeout: number; - keepAliveTimeout: number; } function createServer(requestListener?: http.RequestListener): Server; diff --git a/node_modules/@types/node/index.d.ts b/node_modules/@types/node/index.d.ts index f4d3a9b..af956ee 100644 --- a/node_modules/@types/node/index.d.ts +++ b/node_modules/@types/node/index.d.ts @@ -1,4 +1,4 @@ -// Type definitions for non-npm package Node.js 12.12 +// Type definitions for non-npm package Node.js 14.14 // Project: http://nodejs.org/ // Definitions by: Microsoft TypeScript // DefinitelyTyped @@ -9,7 +9,6 @@ // Benjamin Toueg // Bruno Scheufler // Chigozirim C. -// Christian Vaagland Tellnes // David Junger // Deividas Bakanas // Eugene Y. Q. Shen @@ -23,7 +22,6 @@ // Mariusz Wiktorczyk // Mohsen Azimi // Nicolas Even -// Nicolas Voigt // Nikita Galkin // Parambir Singh // Sebastian Silbermann @@ -31,7 +29,6 @@ // Thomas den Hollander // Wilco Bakker // wwwy3y3 -// Zane Hannan AU // Samuel Ainsworth // Kyle Uehlein // Jordi Oliveras Rovira @@ -40,64 +37,25 @@ // Trivikram Kamat // Minh Son Nguyen // Junxiao Shi +// Ilia Baryshnikov +// ExE Boss +// Surasak Chaisurin +// Piotr Błażejewicz +// Anna Henningsen +// Jason Kwok +// Victor Perin // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped -// NOTE: These definitions support NodeJS and TypeScript 3.2. +// NOTE: These definitions support NodeJS and TypeScript 3.7. +// Typically type modifications should be made in base.d.ts instead of here + +/// // NOTE: TypeScript version-specific augmentations can be found in the following paths: // - ~/base.d.ts - Shared definitions common to all TypeScript versions -// - ~/index.d.ts - Definitions specific to TypeScript 2.1 -// - ~/ts3.2/index.d.ts - Definitions specific to TypeScript 3.2 +// - ~/index.d.ts - Definitions specific to TypeScript 2.8 +// - ~/ts3.5/index.d.ts - Definitions specific to TypeScript 3.5 -// NOTE: Augmentations for TypeScript 3.2 and later should use individual files for overrides -// within the respective ~/ts3.2 (or later) folder. However, this is disallowed for versions -// prior to TypeScript 3.2, so the older definitions will be found here. - -// Base definitions for all NodeJS modules that are not specific to any version of TypeScript: -/// - -// TypeScript 2.1-specific augmentations: - -// Forward-declarations for needed types from es2015 and later (in case users are using `--lib es5`) -// Empty interfaces are used here which merge fine with the real declarations in the lib XXX files -// just to ensure the names are known and node typings can be sued without importing these libs. -// if someone really needs these types the libs need to be added via --lib or in tsconfig.json -interface MapConstructor { } -interface WeakMapConstructor { } -interface SetConstructor { } -interface WeakSetConstructor { } -interface Set {} -interface Map {} -interface ReadonlySet {} -interface Iterable { } -interface IteratorResult { } -interface AsyncIterable { } -interface Iterator { - next(value?: any): IteratorResult; -} -interface IterableIterator { } -interface AsyncIterableIterator {} -interface SymbolConstructor { - readonly iterator: symbol; - readonly asyncIterator: symbol; -} -declare var Symbol: SymbolConstructor; -// even this is just a forward declaration some properties are added otherwise -// it would be allowed to pass anything to e.g. Buffer.from() -interface SharedArrayBuffer { - readonly byteLength: number; - slice(begin?: number, end?: number): SharedArrayBuffer; -} - -declare module "util" { - namespace inspect { - const custom: symbol; - } - namespace promisify { - const custom: symbol; - } - namespace types { - function isBigInt64Array(value: any): boolean; - function isBigUint64Array(value: any): boolean; - } -} +// NOTE: Augmentations for TypeScript 3.5 and later should use individual files for overrides +// within the respective ~/ts3.5 (or later) folder. However, this is disallowed for versions +// prior to TypeScript 3.5, so the older definitions will be found here. diff --git a/node_modules/@types/node/inspector.d.ts b/node_modules/@types/node/inspector.d.ts index b14aed2..1c57734 100644 --- a/node_modules/@types/node/inspector.d.ts +++ b/node_modules/@types/node/inspector.d.ts @@ -3031,4 +3031,11 @@ declare module "inspector" { * Return the URL of the active inspector, or `undefined` if there is none. */ function url(): string | undefined; + + /** + * Blocks until a client (existing or connected later) has sent + * `Runtime.runIfWaitingForDebugger` command. + * An exception will be thrown if there is no active inspector. + */ + function waitForDebugger(): void; } diff --git a/node_modules/@types/node/module.d.ts b/node_modules/@types/node/module.d.ts index f512be7..ffb4a6e 100644 --- a/node_modules/@types/node/module.d.ts +++ b/node_modules/@types/node/module.d.ts @@ -1,3 +1,52 @@ declare module "module" { - export = NodeJS.Module; + import { URL } from "url"; + namespace Module { + /** + * Updates all the live bindings for builtin ES Modules to match the properties of the CommonJS exports. + * It does not add or remove exported names from the ES Modules. + */ + function syncBuiltinESMExports(): void; + + function findSourceMap(path: string, error?: Error): SourceMap; + interface SourceMapPayload { + file: string; + version: number; + sources: string[]; + sourcesContent: string[]; + names: string[]; + mappings: string; + sourceRoot: string; + } + + interface SourceMapping { + generatedLine: number; + generatedColumn: number; + originalSource: string; + originalLine: number; + originalColumn: number; + } + + class SourceMap { + readonly payload: SourceMapPayload; + constructor(payload: SourceMapPayload); + findEntry(line: number, column: number): SourceMapping; + } + } + interface Module extends NodeModule {} + class Module { + static runMain(): void; + static wrap(code: string): string; + + /** + * @deprecated Deprecated since: v12.2.0. Please use createRequire() instead. + */ + static createRequireFromPath(path: string): NodeRequire; + static createRequire(path: string | URL): NodeRequire; + static builtinModules: string[]; + + static Module: typeof Module; + + constructor(id: string, parent?: Module); + } + export = Module; } diff --git a/node_modules/@types/node/net.d.ts b/node_modules/@types/node/net.d.ts index 1e4f971..e6ee1bb 100644 --- a/node_modules/@types/node/net.d.ts +++ b/node_modules/@types/node/net.d.ts @@ -58,22 +58,22 @@ declare module "net" { // Extended base methods write(buffer: Uint8Array | string, cb?: (err?: Error) => void): boolean; - write(str: Uint8Array | string, encoding?: string, cb?: (err?: Error) => void): boolean; + write(str: Uint8Array | string, encoding?: BufferEncoding, cb?: (err?: Error) => void): boolean; connect(options: SocketConnectOpts, connectionListener?: () => void): this; connect(port: number, host: string, connectionListener?: () => void): this; connect(port: number, connectionListener?: () => void): this; connect(path: string, connectionListener?: () => void): this; - setEncoding(encoding?: string): this; + setEncoding(encoding?: BufferEncoding): this; pause(): this; resume(): this; setTimeout(timeout: number, callback?: () => void): this; setNoDelay(noDelay?: boolean): this; setKeepAlive(enable?: boolean, initialDelay?: number): this; - address(): AddressInfo | string; - unref(): void; - ref(): void; + address(): AddressInfo | {}; + unref(): this; + ref(): this; readonly bufferSize: number; readonly bytesRead: number; @@ -89,7 +89,7 @@ declare module "net" { // Extended base methods end(cb?: () => void): void; end(buffer: Uint8Array | string, cb?: () => void): void; - end(str: Uint8Array | string, encoding?: string, cb?: () => void): void; + end(str: Uint8Array | string, encoding?: BufferEncoding, cb?: () => void): void; /** * events.EventEmitter diff --git a/node_modules/@types/node/os.d.ts b/node_modules/@types/node/os.d.ts index 37c45a9..1aadc68 100644 --- a/node_modules/@types/node/os.d.ts +++ b/node_modules/@types/node/os.d.ts @@ -46,201 +46,177 @@ declare module "os" { function cpus(): CpuInfo[]; function type(): string; function release(): string; - function networkInterfaces(): { [index: string]: NetworkInterfaceInfo[] }; + function networkInterfaces(): NodeJS.Dict; function homedir(): string; function userInfo(options: { encoding: 'buffer' }): UserInfo; - function userInfo(options?: { encoding: string }): UserInfo; - const constants: { - UV_UDP_REUSEADDR: number; - // signals: { [key in NodeJS.Signals]: number; }; @todo: change after migration to typescript 2.1 - signals: { - SIGHUP: number; - SIGINT: number; - SIGQUIT: number; - SIGILL: number; - SIGTRAP: number; - SIGABRT: number; - SIGIOT: number; - SIGBUS: number; - SIGFPE: number; - SIGKILL: number; - SIGUSR1: number; - SIGSEGV: number; - SIGUSR2: number; - SIGPIPE: number; - SIGALRM: number; - SIGTERM: number; - SIGCHLD: number; - SIGSTKFLT: number; - SIGCONT: number; - SIGSTOP: number; - SIGTSTP: number; - SIGBREAK: number; - SIGTTIN: number; - SIGTTOU: number; - SIGURG: number; - SIGXCPU: number; - SIGXFSZ: number; - SIGVTALRM: number; - SIGPROF: number; - SIGWINCH: number; - SIGIO: number; - SIGPOLL: number; - SIGLOST: number; - SIGPWR: number; - SIGINFO: number; - SIGSYS: number; - SIGUNUSED: number; - }; - errno: { - E2BIG: number; - EACCES: number; - EADDRINUSE: number; - EADDRNOTAVAIL: number; - EAFNOSUPPORT: number; - EAGAIN: number; - EALREADY: number; - EBADF: number; - EBADMSG: number; - EBUSY: number; - ECANCELED: number; - ECHILD: number; - ECONNABORTED: number; - ECONNREFUSED: number; - ECONNRESET: number; - EDEADLK: number; - EDESTADDRREQ: number; - EDOM: number; - EDQUOT: number; - EEXIST: number; - EFAULT: number; - EFBIG: number; - EHOSTUNREACH: number; - EIDRM: number; - EILSEQ: number; - EINPROGRESS: number; - EINTR: number; - EINVAL: number; - EIO: number; - EISCONN: number; - EISDIR: number; - ELOOP: number; - EMFILE: number; - EMLINK: number; - EMSGSIZE: number; - EMULTIHOP: number; - ENAMETOOLONG: number; - ENETDOWN: number; - ENETRESET: number; - ENETUNREACH: number; - ENFILE: number; - ENOBUFS: number; - ENODATA: number; - ENODEV: number; - ENOENT: number; - ENOEXEC: number; - ENOLCK: number; - ENOLINK: number; - ENOMEM: number; - ENOMSG: number; - ENOPROTOOPT: number; - ENOSPC: number; - ENOSR: number; - ENOSTR: number; - ENOSYS: number; - ENOTCONN: number; - ENOTDIR: number; - ENOTEMPTY: number; - ENOTSOCK: number; - ENOTSUP: number; - ENOTTY: number; - ENXIO: number; - EOPNOTSUPP: number; - EOVERFLOW: number; - EPERM: number; - EPIPE: number; - EPROTO: number; - EPROTONOSUPPORT: number; - EPROTOTYPE: number; - ERANGE: number; - EROFS: number; - ESPIPE: number; - ESRCH: number; - ESTALE: number; - ETIME: number; - ETIMEDOUT: number; - ETXTBSY: number; - EWOULDBLOCK: number; - EXDEV: number; - WSAEINTR: number; - WSAEBADF: number; - WSAEACCES: number; - WSAEFAULT: number; - WSAEINVAL: number; - WSAEMFILE: number; - WSAEWOULDBLOCK: number; - WSAEINPROGRESS: number; - WSAEALREADY: number; - WSAENOTSOCK: number; - WSAEDESTADDRREQ: number; - WSAEMSGSIZE: number; - WSAEPROTOTYPE: number; - WSAENOPROTOOPT: number; - WSAEPROTONOSUPPORT: number; - WSAESOCKTNOSUPPORT: number; - WSAEOPNOTSUPP: number; - WSAEPFNOSUPPORT: number; - WSAEAFNOSUPPORT: number; - WSAEADDRINUSE: number; - WSAEADDRNOTAVAIL: number; - WSAENETDOWN: number; - WSAENETUNREACH: number; - WSAENETRESET: number; - WSAECONNABORTED: number; - WSAECONNRESET: number; - WSAENOBUFS: number; - WSAEISCONN: number; - WSAENOTCONN: number; - WSAESHUTDOWN: number; - WSAETOOMANYREFS: number; - WSAETIMEDOUT: number; - WSAECONNREFUSED: number; - WSAELOOP: number; - WSAENAMETOOLONG: number; - WSAEHOSTDOWN: number; - WSAEHOSTUNREACH: number; - WSAENOTEMPTY: number; - WSAEPROCLIM: number; - WSAEUSERS: number; - WSAEDQUOT: number; - WSAESTALE: number; - WSAEREMOTE: number; - WSASYSNOTREADY: number; - WSAVERNOTSUPPORTED: number; - WSANOTINITIALISED: number; - WSAEDISCON: number; - WSAENOMORE: number; - WSAECANCELLED: number; - WSAEINVALIDPROCTABLE: number; - WSAEINVALIDPROVIDER: number; - WSAEPROVIDERFAILEDINIT: number; - WSASYSCALLFAILURE: number; - WSASERVICE_NOT_FOUND: number; - WSATYPE_NOT_FOUND: number; - WSA_E_NO_MORE: number; - WSA_E_CANCELLED: number; - WSAEREFUSED: number; - }; - priority: { - PRIORITY_LOW: number; - PRIORITY_BELOW_NORMAL: number; - PRIORITY_NORMAL: number; - PRIORITY_ABOVE_NORMAL: number; - PRIORITY_HIGH: number; - PRIORITY_HIGHEST: number; - } + function userInfo(options?: { encoding: BufferEncoding }): UserInfo; + + type SignalConstants = { + [key in NodeJS.Signals]: number; }; + + namespace constants { + const UV_UDP_REUSEADDR: number; + namespace signals {} + const signals: SignalConstants; + namespace errno { + const E2BIG: number; + const EACCES: number; + const EADDRINUSE: number; + const EADDRNOTAVAIL: number; + const EAFNOSUPPORT: number; + const EAGAIN: number; + const EALREADY: number; + const EBADF: number; + const EBADMSG: number; + const EBUSY: number; + const ECANCELED: number; + const ECHILD: number; + const ECONNABORTED: number; + const ECONNREFUSED: number; + const ECONNRESET: number; + const EDEADLK: number; + const EDESTADDRREQ: number; + const EDOM: number; + const EDQUOT: number; + const EEXIST: number; + const EFAULT: number; + const EFBIG: number; + const EHOSTUNREACH: number; + const EIDRM: number; + const EILSEQ: number; + const EINPROGRESS: number; + const EINTR: number; + const EINVAL: number; + const EIO: number; + const EISCONN: number; + const EISDIR: number; + const ELOOP: number; + const EMFILE: number; + const EMLINK: number; + const EMSGSIZE: number; + const EMULTIHOP: number; + const ENAMETOOLONG: number; + const ENETDOWN: number; + const ENETRESET: number; + const ENETUNREACH: number; + const ENFILE: number; + const ENOBUFS: number; + const ENODATA: number; + const ENODEV: number; + const ENOENT: number; + const ENOEXEC: number; + const ENOLCK: number; + const ENOLINK: number; + const ENOMEM: number; + const ENOMSG: number; + const ENOPROTOOPT: number; + const ENOSPC: number; + const ENOSR: number; + const ENOSTR: number; + const ENOSYS: number; + const ENOTCONN: number; + const ENOTDIR: number; + const ENOTEMPTY: number; + const ENOTSOCK: number; + const ENOTSUP: number; + const ENOTTY: number; + const ENXIO: number; + const EOPNOTSUPP: number; + const EOVERFLOW: number; + const EPERM: number; + const EPIPE: number; + const EPROTO: number; + const EPROTONOSUPPORT: number; + const EPROTOTYPE: number; + const ERANGE: number; + const EROFS: number; + const ESPIPE: number; + const ESRCH: number; + const ESTALE: number; + const ETIME: number; + const ETIMEDOUT: number; + const ETXTBSY: number; + const EWOULDBLOCK: number; + const EXDEV: number; + const WSAEINTR: number; + const WSAEBADF: number; + const WSAEACCES: number; + const WSAEFAULT: number; + const WSAEINVAL: number; + const WSAEMFILE: number; + const WSAEWOULDBLOCK: number; + const WSAEINPROGRESS: number; + const WSAEALREADY: number; + const WSAENOTSOCK: number; + const WSAEDESTADDRREQ: number; + const WSAEMSGSIZE: number; + const WSAEPROTOTYPE: number; + const WSAENOPROTOOPT: number; + const WSAEPROTONOSUPPORT: number; + const WSAESOCKTNOSUPPORT: number; + const WSAEOPNOTSUPP: number; + const WSAEPFNOSUPPORT: number; + const WSAEAFNOSUPPORT: number; + const WSAEADDRINUSE: number; + const WSAEADDRNOTAVAIL: number; + const WSAENETDOWN: number; + const WSAENETUNREACH: number; + const WSAENETRESET: number; + const WSAECONNABORTED: number; + const WSAECONNRESET: number; + const WSAENOBUFS: number; + const WSAEISCONN: number; + const WSAENOTCONN: number; + const WSAESHUTDOWN: number; + const WSAETOOMANYREFS: number; + const WSAETIMEDOUT: number; + const WSAECONNREFUSED: number; + const WSAELOOP: number; + const WSAENAMETOOLONG: number; + const WSAEHOSTDOWN: number; + const WSAEHOSTUNREACH: number; + const WSAENOTEMPTY: number; + const WSAEPROCLIM: number; + const WSAEUSERS: number; + const WSAEDQUOT: number; + const WSAESTALE: number; + const WSAEREMOTE: number; + const WSASYSNOTREADY: number; + const WSAVERNOTSUPPORTED: number; + const WSANOTINITIALISED: number; + const WSAEDISCON: number; + const WSAENOMORE: number; + const WSAECANCELLED: number; + const WSAEINVALIDPROCTABLE: number; + const WSAEINVALIDPROVIDER: number; + const WSAEPROVIDERFAILEDINIT: number; + const WSASYSCALLFAILURE: number; + const WSASERVICE_NOT_FOUND: number; + const WSATYPE_NOT_FOUND: number; + const WSA_E_NO_MORE: number; + const WSA_E_CANCELLED: number; + const WSAEREFUSED: number; + } + namespace priority { + const PRIORITY_LOW: number; + const PRIORITY_BELOW_NORMAL: number; + const PRIORITY_NORMAL: number; + const PRIORITY_ABOVE_NORMAL: number; + const PRIORITY_HIGH: number; + const PRIORITY_HIGHEST: number; + } + } + function arch(): string; + /** + * Returns a string identifying the kernel version. + * On POSIX systems, the operating system release is determined by calling + * [uname(3)][]. On Windows, `pRtlGetVersion` is used, and if it is not available, + * `GetVersionExW()` will be used. See + * https://en.wikipedia.org/wiki/Uname#Examples for more information. + */ + function version(): string; function platform(): NodeJS.Platform; function tmpdir(): string; const EOL: string; diff --git a/node_modules/@types/node/package.json b/node_modules/@types/node/package.json index 440f065..25cdf8b 100644 --- a/node_modules/@types/node/package.json +++ b/node_modules/@types/node/package.json @@ -1,34 +1,94 @@ { - "_from": "@types/node@12.12.11", - "_id": "@types/node@12.12.11", + "_args": [ + [ + "@types/node@14.14.6", + "/Users/marocchino/Documents/sticky-pull-request-comment" + ] + ], + "_from": "@types/node@14.14.6", + "_id": "@types/node@14.14.6", "_inBundle": false, - "_integrity": "sha512-O+x6uIpa6oMNTkPuHDa9MhMMehlxLAd5QcOvKRjAFsBVpeFWTOPnXbDvILvFgFFZfQ1xh1EZi1FbXxUix+zpsQ==", + "_integrity": "sha512-6QlRuqsQ/Ox/aJEQWBEJG7A9+u7oSYl3mem/K8IzxXG/kAGbV1YPD9Bg9Zw3vyxC/YP+zONKwy8hGkSt1jxFMw==", "_location": "/@types/node", "_phantomChildren": {}, "_requested": { "type": "version", "registry": true, - "raw": "@types/node@12.12.11", + "raw": "@types/node@14.14.6", "name": "@types/node", "escapedName": "@types%2fnode", "scope": "@types", - "rawSpec": "12.12.11", + "rawSpec": "14.14.6", "saveSpec": null, - "fetchSpec": "12.12.11" + "fetchSpec": "14.14.6" }, "_requiredBy": [ "#DEV:/", - "#USER", - "/@octokit/types" + "/@jest/test-sequencer/@jest/console", + "/@jest/test-sequencer/@jest/types", + "/@jest/test-sequencer/jest-haste-map", + "/@jest/test-sequencer/jest-serializer", + "/@jest/test-sequencer/jest-util", + "/@jest/test-sequencer/jest-worker", + "/@jest/types", + "/@octokit/types", + "/@types/graceful-fs", + "/jest-circus", + "/jest-circus/@jest/console", + "/jest-circus/@jest/environment", + "/jest-circus/@jest/fake-timers", + "/jest-circus/@jest/types", + "/jest-circus/jest-haste-map", + "/jest-circus/jest-mock", + "/jest-circus/jest-serializer", + "/jest-circus/jest-util", + "/jest-circus/jest-worker", + "/jest-config/@jest/environment", + "/jest-config/@jest/fake-timers", + "/jest-config/@jest/types", + "/jest-config/jest-environment-jsdom", + "/jest-config/jest-environment-node", + "/jest-config/jest-haste-map", + "/jest-config/jest-mock", + "/jest-config/jest-serializer", + "/jest-config/jest-util", + "/jest-config/jest-worker", + "/jest-jasmine2", + "/jest-jasmine2/@jest/console", + "/jest-jasmine2/@jest/environment", + "/jest-jasmine2/@jest/fake-timers", + "/jest-jasmine2/@jest/types", + "/jest-jasmine2/jest-haste-map", + "/jest-jasmine2/jest-mock", + "/jest-jasmine2/jest-serializer", + "/jest-jasmine2/jest-util", + "/jest-jasmine2/jest-worker", + "/jest-runner", + "/jest-runner/@jest/console", + "/jest-runner/@jest/environment", + "/jest-runner/@jest/fake-timers", + "/jest-runner/@jest/types", + "/jest-runner/jest-haste-map", + "/jest-runner/jest-mock", + "/jest-runner/jest-serializer", + "/jest-runner/jest-util", + "/jest-runner/jest-worker", + "/jest-runtime/@jest/console", + "/jest-runtime/@jest/environment", + "/jest-runtime/@jest/fake-timers", + "/jest-runtime/@jest/types", + "/jest-runtime/jest-haste-map", + "/jest-runtime/jest-mock", + "/jest-runtime/jest-serializer", + "/jest-runtime/jest-util", + "/jest-runtime/jest-worker" ], - "_resolved": "https://registry.npmjs.org/@types/node/-/node-12.12.11.tgz", - "_shasum": "bec2961975888d964196bf0016a2f984d793d3ce", - "_spec": "@types/node@12.12.11", - "_where": "/Users/shim.taewon/Documents/sticky-pull-request-comment", + "_resolved": "https://registry.npmjs.org/@types/node/-/node-14.14.6.tgz", + "_spec": "14.14.6", + "_where": "/Users/marocchino/Documents/sticky-pull-request-comment", "bugs": { "url": "https://github.com/DefinitelyTyped/DefinitelyTyped/issues" }, - "bundleDependencies": false, "contributors": [ { "name": "Microsoft TypeScript", @@ -66,10 +126,6 @@ "name": "Chigozirim C.", "url": "https://github.com/smac89" }, - { - "name": "Christian Vaagland Tellnes", - "url": "https://github.com/tellnes" - }, { "name": "David Junger", "url": "https://github.com/touffy" @@ -122,10 +178,6 @@ "name": "Nicolas Even", "url": "https://github.com/n-e" }, - { - "name": "Nicolas Voigt", - "url": "https://github.com/octo-sniffle" - }, { "name": "Nikita Galkin", "url": "https://github.com/galkin" @@ -154,10 +206,6 @@ "name": "wwwy3y3", "url": "https://github.com/wwwy3y3" }, - { - "name": "Zane Hannan AU", - "url": "https://github.com/ZaneHannanAU" - }, { "name": "Samuel Ainsworth", "url": "https://github.com/samuela" @@ -189,10 +237,37 @@ { "name": "Junxiao Shi", "url": "https://github.com/yoursunny" + }, + { + "name": "Ilia Baryshnikov", + "url": "https://github.com/qwelias" + }, + { + "name": "ExE Boss", + "url": "https://github.com/ExE-Boss" + }, + { + "name": "Surasak Chaisurin", + "url": "https://github.com/Ryan-Willpower" + }, + { + "name": "Piotr Błażejewicz", + "url": "https://github.com/peterblazejewicz" + }, + { + "name": "Anna Henningsen", + "url": "https://github.com/addaleax" + }, + { + "name": "Jason Kwok", + "url": "https://github.com/JasonHK" + }, + { + "name": "Victor Perin", + "url": "https://github.com/victorperin" } ], "dependencies": {}, - "deprecated": false, "description": "TypeScript definitions for Node.js", "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped#readme", "license": "MIT", @@ -204,15 +279,20 @@ "directory": "types/node" }, "scripts": {}, - "typeScriptVersion": "2.8", + "typeScriptVersion": "3.2", "types": "index.d.ts", - "typesPublisherContentHash": "db8a3e1fadc482615dd04e1c1d0d26eca954d792aed008eac14078e02f14e87b", + "typesPublisherContentHash": "1d51f247935976ab4813ff9000f53f55476586bb3594e4b964bd47728da00a20", "typesVersions": { - ">=3.2.0-0": { + "<=3.4": { "*": [ - "ts3.2/*" + "ts3.4/*" + ] + }, + "<=3.6": { + "*": [ + "ts3.6/*" ] } }, - "version": "12.12.11" + "version": "14.14.6" } diff --git a/node_modules/@types/node/path.d.ts b/node_modules/@types/node/path.d.ts index 2f4a549..0273d58 100644 --- a/node_modules/@types/node/path.d.ts +++ b/node_modules/@types/node/path.d.ts @@ -1,159 +1,153 @@ declare module "path" { - /** - * A parsed path object generated by path.parse() or consumed by path.format(). - */ - interface ParsedPath { + namespace path { /** - * The root of the path such as '/' or 'c:\' + * A parsed path object generated by path.parse() or consumed by path.format(). */ - root: string; - /** - * The full directory path such as '/home/user/dir' or 'c:\path\dir' - */ - dir: string; - /** - * The file name including extension (if any) such as 'index.html' - */ - base: string; - /** - * The file extension (if any) such as '.html' - */ - ext: string; - /** - * The file name without extension (if any) such as 'index' - */ - name: string; - } - interface FormatInputPathObject { - /** - * The root of the path such as '/' or 'c:\' - */ - root?: string; - /** - * The full directory path such as '/home/user/dir' or 'c:\path\dir' - */ - dir?: string; - /** - * The file name including extension (if any) such as 'index.html' - */ - base?: string; - /** - * The file extension (if any) such as '.html' - */ - ext?: string; - /** - * The file name without extension (if any) such as 'index' - */ - name?: string; - } + interface ParsedPath { + /** + * The root of the path such as '/' or 'c:\' + */ + root: string; + /** + * The full directory path such as '/home/user/dir' or 'c:\path\dir' + */ + dir: string; + /** + * The file name including extension (if any) such as 'index.html' + */ + base: string; + /** + * The file extension (if any) such as '.html' + */ + ext: string; + /** + * The file name without extension (if any) such as 'index' + */ + name: string; + } - /** - * Normalize a string path, reducing '..' and '.' parts. - * When multiple slashes are found, they're replaced by a single one; when the path contains a trailing slash, it is preserved. On Windows backslashes are used. - * - * @param p string path to normalize. - */ - function normalize(p: string): string; - /** - * Join all arguments together and normalize the resulting path. - * Arguments must be strings. In v0.8, non-string arguments were silently ignored. In v0.10 and up, an exception is thrown. - * - * @param paths paths to join. - */ - function join(...paths: string[]): string; - /** - * The right-most parameter is considered {to}. Other parameters are considered an array of {from}. - * - * Starting from leftmost {from} parameter, resolves {to} to an absolute path. - * - * If {to} isn't already absolute, {from} arguments are prepended in right to left order, - * until an absolute path is found. If after using all {from} paths still no absolute path is found, - * the current working directory is used as well. The resulting path is normalized, - * and trailing slashes are removed unless the path gets resolved to the root directory. - * - * @param pathSegments string paths to join. Non-string arguments are ignored. - */ - function resolve(...pathSegments: string[]): string; - /** - * Determines whether {path} is an absolute path. An absolute path will always resolve to the same location, regardless of the working directory. - * - * @param path path to test. - */ - function isAbsolute(path: string): boolean; - /** - * Solve the relative path from {from} to {to}. - * At times we have two absolute paths, and we need to derive the relative path from one to the other. This is actually the reverse transform of path.resolve. - */ - function relative(from: string, to: string): string; - /** - * Return the directory name of a path. Similar to the Unix dirname command. - * - * @param p the path to evaluate. - */ - function dirname(p: string): string; - /** - * Return the last portion of a path. Similar to the Unix basename command. - * Often used to extract the file name from a fully qualified path. - * - * @param p the path to evaluate. - * @param ext optionally, an extension to remove from the result. - */ - function basename(p: string, ext?: string): string; - /** - * Return the extension of the path, from the last '.' to end of string in the last portion of the path. - * If there is no '.' in the last portion of the path or the first character of it is '.', then it returns an empty string - * - * @param p the path to evaluate. - */ - function extname(p: string): string; - /** - * The platform-specific file separator. '\\' or '/'. - */ - const sep: '\\' | '/'; - /** - * The platform-specific file delimiter. ';' or ':'. - */ - const delimiter: ';' | ':'; - /** - * Returns an object from a path string - the opposite of format(). - * - * @param pathString path to evaluate. - */ - function parse(pathString: string): ParsedPath; - /** - * Returns a path string from an object - the opposite of parse(). - * - * @param pathString path to evaluate. - */ - function format(pathObject: FormatInputPathObject): string; + interface FormatInputPathObject { + /** + * The root of the path such as '/' or 'c:\' + */ + root?: string; + /** + * The full directory path such as '/home/user/dir' or 'c:\path\dir' + */ + dir?: string; + /** + * The file name including extension (if any) such as 'index.html' + */ + base?: string; + /** + * The file extension (if any) such as '.html' + */ + ext?: string; + /** + * The file name without extension (if any) such as 'index' + */ + name?: string; + } - namespace posix { - function normalize(p: string): string; - function join(...paths: string[]): string; - function resolve(...pathSegments: string[]): string; - function isAbsolute(p: string): boolean; - function relative(from: string, to: string): string; - function dirname(p: string): string; - function basename(p: string, ext?: string): string; - function extname(p: string): string; - const sep: string; - const delimiter: string; - function parse(p: string): ParsedPath; - function format(pP: FormatInputPathObject): string; - } - - namespace win32 { - function normalize(p: string): string; - function join(...paths: string[]): string; - function resolve(...pathSegments: string[]): string; - function isAbsolute(p: string): boolean; - function relative(from: string, to: string): string; - function dirname(p: string): string; - function basename(p: string, ext?: string): string; - function extname(p: string): string; - const sep: string; - const delimiter: string; - function parse(p: string): ParsedPath; - function format(pP: FormatInputPathObject): string; + interface PlatformPath { + /** + * Normalize a string path, reducing '..' and '.' parts. + * When multiple slashes are found, they're replaced by a single one; when the path contains a trailing slash, it is preserved. On Windows backslashes are used. + * + * @param p string path to normalize. + */ + normalize(p: string): string; + /** + * Join all arguments together and normalize the resulting path. + * Arguments must be strings. In v0.8, non-string arguments were silently ignored. In v0.10 and up, an exception is thrown. + * + * @param paths paths to join. + */ + join(...paths: string[]): string; + /** + * The right-most parameter is considered {to}. Other parameters are considered an array of {from}. + * + * Starting from leftmost {from} parameter, resolves {to} to an absolute path. + * + * If {to} isn't already absolute, {from} arguments are prepended in right to left order, + * until an absolute path is found. If after using all {from} paths still no absolute path is found, + * the current working directory is used as well. The resulting path is normalized, + * and trailing slashes are removed unless the path gets resolved to the root directory. + * + * @param pathSegments string paths to join. Non-string arguments are ignored. + */ + resolve(...pathSegments: string[]): string; + /** + * Determines whether {path} is an absolute path. An absolute path will always resolve to the same location, regardless of the working directory. + * + * @param path path to test. + */ + isAbsolute(p: string): boolean; + /** + * Solve the relative path from {from} to {to}. + * At times we have two absolute paths, and we need to derive the relative path from one to the other. This is actually the reverse transform of path.resolve. + */ + relative(from: string, to: string): string; + /** + * Return the directory name of a path. Similar to the Unix dirname command. + * + * @param p the path to evaluate. + */ + dirname(p: string): string; + /** + * Return the last portion of a path. Similar to the Unix basename command. + * Often used to extract the file name from a fully qualified path. + * + * @param p the path to evaluate. + * @param ext optionally, an extension to remove from the result. + */ + basename(p: string, ext?: string): string; + /** + * Return the extension of the path, from the last '.' to end of string in the last portion of the path. + * If there is no '.' in the last portion of the path or the first character of it is '.', then it returns an empty string + * + * @param p the path to evaluate. + */ + extname(p: string): string; + /** + * The platform-specific file separator. '\\' or '/'. + */ + readonly sep: string; + /** + * The platform-specific file delimiter. ';' or ':'. + */ + readonly delimiter: string; + /** + * Returns an object from a path string - the opposite of format(). + * + * @param pathString path to evaluate. + */ + parse(p: string): ParsedPath; + /** + * Returns a path string from an object - the opposite of parse(). + * + * @param pathString path to evaluate. + */ + format(pP: FormatInputPathObject): string; + /** + * On Windows systems only, returns an equivalent namespace-prefixed path for the given path. + * If path is not a string, path will be returned without modifications. + * This method is meaningful only on Windows system. + * On POSIX systems, the method is non-operational and always returns path without modifications. + */ + toNamespacedPath(path: string): string; + /** + * Posix specific pathing. + * Same as parent object on posix. + */ + readonly posix: PlatformPath; + /** + * Windows specific pathing. + * Same as parent object on windows + */ + readonly win32: PlatformPath; + } } + const path: path.PlatformPath; + export = path; } diff --git a/node_modules/@types/node/perf_hooks.d.ts b/node_modules/@types/node/perf_hooks.d.ts index bf44d44..bbea938 100644 --- a/node_modules/@types/node/perf_hooks.d.ts +++ b/node_modules/@types/node/perf_hooks.d.ts @@ -1,5 +1,7 @@ -declare module "perf_hooks" { - import { AsyncResource } from "async_hooks"; +declare module 'perf_hooks' { + import { AsyncResource } from 'async_hooks'; + + type EntryType = 'node' | 'mark' | 'measure' | 'gc' | 'function' | 'http2' | 'http'; interface PerformanceEntry { /** @@ -22,14 +24,21 @@ declare module "perf_hooks" { * The type of the performance entry. * Currently it may be one of: 'node', 'mark', 'measure', 'gc', or 'function'. */ - readonly entryType: string; + readonly entryType: EntryType; /** - * When performanceEntry.entryType is equal to 'gc', the performance.kind property identifies + * When `performanceEntry.entryType` is equal to 'gc', `the performance.kind` property identifies * the type of garbage collection operation that occurred. - * The value may be one of perf_hooks.constants. + * See perf_hooks.constants for valid values. */ readonly kind?: number; + + /** + * When `performanceEntry.entryType` is equal to 'gc', the `performance.flags` + * property contains additional information about garbage collection operation. + * See perf_hooks.constants for valid values. + */ + readonly flags?: number; } interface PerformanceNodeTiming extends PerformanceEntry { @@ -39,74 +48,43 @@ declare module "perf_hooks" { readonly bootstrapComplete: number; /** - * The high resolution millisecond timestamp at which cluster processing ended. + * The high resolution millisecond timestamp at which the Node.js process completed bootstrapping. + * If bootstrapping has not yet finished, the property has the value of -1. */ - readonly clusterSetupEnd: number; + readonly environment: number; /** - * The high resolution millisecond timestamp at which cluster processing started. + * The high resolution millisecond timestamp at which the Node.js environment was initialized. */ - readonly clusterSetupStart: number; + readonly idleTime: number; /** - * The high resolution millisecond timestamp at which the Node.js event loop exited. + * The high resolution millisecond timestamp of the amount of time the event loop has been idle + * within the event loop's event provider (e.g. `epoll_wait`). This does not take CPU usage + * into consideration. If the event loop has not yet started (e.g., in the first tick of the main script), + * the property has the value of 0. */ readonly loopExit: number; /** * The high resolution millisecond timestamp at which the Node.js event loop started. + * If the event loop has not yet started (e.g., in the first tick of the main script), the property has the value of -1. */ readonly loopStart: number; - /** - * The high resolution millisecond timestamp at which main module load ended. - */ - readonly moduleLoadEnd: number; - - /** - * The high resolution millisecond timestamp at which main module load started. - */ - readonly moduleLoadStart: number; - - /** - * The high resolution millisecond timestamp at which the Node.js process was initialized. - */ - readonly nodeStart: number; - - /** - * The high resolution millisecond timestamp at which preload module load ended. - */ - readonly preloadModuleLoadEnd: number; - - /** - * The high resolution millisecond timestamp at which preload module load started. - */ - readonly preloadModuleLoadStart: number; - - /** - * The high resolution millisecond timestamp at which third_party_main processing ended. - */ - readonly thirdPartyMainEnd: number; - - /** - * The high resolution millisecond timestamp at which third_party_main processing started. - */ - readonly thirdPartyMainStart: number; - /** * The high resolution millisecond timestamp at which the V8 platform was initialized. */ readonly v8Start: number; } - interface Performance { - /** - * If name is not provided, removes all PerformanceFunction objects from the Performance Timeline. - * If name is provided, removes entries with name. - * @param name - */ - clearFunctions(name?: string): void; + interface EventLoopUtilization { + idle: number; + active: number; + utilization: number; + } + interface Performance { /** * If name is not provided, removes all PerformanceMark objects from the Performance Timeline. * If name is provided, removes only the named mark. @@ -114,35 +92,6 @@ declare module "perf_hooks" { */ clearMarks(name?: string): void; - /** - * If name is not provided, removes all PerformanceMeasure objects from the Performance Timeline. - * If name is provided, removes only objects whose performanceEntry.name matches name. - */ - clearMeasures(name?: string): void; - - /** - * Returns a list of all PerformanceEntry objects in chronological order with respect to performanceEntry.startTime. - * @return list of all PerformanceEntry objects - */ - getEntries(): PerformanceEntry[]; - - /** - * Returns a list of all PerformanceEntry objects in chronological order with respect to performanceEntry.startTime - * whose performanceEntry.name is equal to name, and optionally, whose performanceEntry.entryType is equal to type. - * @param name - * @param type - * @return list of all PerformanceEntry objects - */ - getEntriesByName(name: string, type?: string): PerformanceEntry[]; - - /** - * Returns a list of all PerformanceEntry objects in chronological order with respect to performanceEntry.startTime - * whose performanceEntry.entryType is equal to type. - * @param type - * @return list of all PerformanceEntry objects - */ - getEntriesByType(type: string): PerformanceEntry[]; - /** * Creates a new PerformanceMark entry in the Performance Timeline. * A PerformanceMark is a subclass of PerformanceEntry whose performanceEntry.entryType is always 'mark', @@ -190,6 +139,16 @@ declare module "perf_hooks" { * @param fn */ timerify any>(fn: T): T; + + /** + * eventLoopUtilization is similar to CPU utilization except that it is calculated using high precision wall-clock time. + * It represents the percentage of time the event loop has spent outside the event loop's event provider (e.g. epoll_wait). + * No other CPU idle time is taken into consideration. + * + * @param util1 The result of a previous call to eventLoopUtilization() + * @param util2 The result of a previous call to eventLoopUtilization() prior to util1 + */ + eventLoopUtilization(util1?: EventLoopUtilization, util2?: EventLoopUtilization): EventLoopUtilization; } interface PerformanceObserverEntryList { @@ -202,13 +161,13 @@ declare module "perf_hooks" { * @return a list of PerformanceEntry objects in chronological order with respect to performanceEntry.startTime * whose performanceEntry.name is equal to name, and optionally, whose performanceEntry.entryType is equal to type. */ - getEntriesByName(name: string, type?: string): PerformanceEntry[]; + getEntriesByName(name: string, type?: EntryType): PerformanceEntry[]; /** * @return Returns a list of PerformanceEntry objects in chronological order with respect to performanceEntry.startTime * whose performanceEntry.entryType is equal to type. */ - getEntriesByType(type: string): PerformanceEntry[]; + getEntriesByType(type: EntryType): PerformanceEntry[]; } type PerformanceObserverCallback = (list: PerformanceObserverEntryList, observer: PerformanceObserver) => void; @@ -227,7 +186,7 @@ declare module "perf_hooks" { * Property buffered defaults to false. * @param options */ - observe(options: { entryTypes: string[], buffered?: boolean }): void; + observe(options: { entryTypes: ReadonlyArray; buffered?: boolean }): void; } namespace constants { @@ -235,6 +194,14 @@ declare module "perf_hooks" { const NODE_PERFORMANCE_GC_MINOR: number; const NODE_PERFORMANCE_GC_INCREMENTAL: number; const NODE_PERFORMANCE_GC_WEAKCB: number; + + const NODE_PERFORMANCE_GC_FLAGS_NO: number; + const NODE_PERFORMANCE_GC_FLAGS_CONSTRUCT_RETAINED: number; + const NODE_PERFORMANCE_GC_FLAGS_FORCED: number; + const NODE_PERFORMANCE_GC_FLAGS_SYNCHRONOUS_PHANTOM_PROCESSING: number; + const NODE_PERFORMANCE_GC_FLAGS_ALL_AVAILABLE_GARBAGE: number; + const NODE_PERFORMANCE_GC_FLAGS_ALL_EXTERNAL_MEMORY: number; + const NODE_PERFORMANCE_GC_FLAGS_SCHEDULE_IDLE: number; } const performance: Performance; diff --git a/node_modules/@types/node/process.d.ts b/node_modules/@types/node/process.d.ts index d007d4e..bd38626 100644 --- a/node_modules/@types/node/process.d.ts +++ b/node_modules/@types/node/process.d.ts @@ -2,12 +2,405 @@ declare module "process" { import * as tty from "tty"; global { + var process: NodeJS.Process; + namespace NodeJS { // this namespace merge is here because these are specifically used // as the type for process.stdin, process.stdout, and process.stderr. // they can't live in tty.d.ts because we need to disambiguate the imported name. interface ReadStream extends tty.ReadStream {} interface WriteStream extends tty.WriteStream {} + + interface MemoryUsage { + rss: number; + heapTotal: number; + heapUsed: number; + external: number; + arrayBuffers: number; + } + + interface CpuUsage { + user: number; + system: number; + } + + interface ProcessRelease { + name: string; + sourceUrl?: string; + headersUrl?: string; + libUrl?: string; + lts?: string; + } + + interface ProcessVersions extends Dict { + http_parser: string; + node: string; + v8: string; + ares: string; + uv: string; + zlib: string; + modules: string; + openssl: string; + } + + type Platform = 'aix' + | 'android' + | 'darwin' + | 'freebsd' + | 'linux' + | 'openbsd' + | 'sunos' + | 'win32' + | 'cygwin' + | 'netbsd'; + + type Signals = + "SIGABRT" | "SIGALRM" | "SIGBUS" | "SIGCHLD" | "SIGCONT" | "SIGFPE" | "SIGHUP" | "SIGILL" | "SIGINT" | "SIGIO" | + "SIGIOT" | "SIGKILL" | "SIGPIPE" | "SIGPOLL" | "SIGPROF" | "SIGPWR" | "SIGQUIT" | "SIGSEGV" | "SIGSTKFLT" | + "SIGSTOP" | "SIGSYS" | "SIGTERM" | "SIGTRAP" | "SIGTSTP" | "SIGTTIN" | "SIGTTOU" | "SIGUNUSED" | "SIGURG" | + "SIGUSR1" | "SIGUSR2" | "SIGVTALRM" | "SIGWINCH" | "SIGXCPU" | "SIGXFSZ" | "SIGBREAK" | "SIGLOST" | "SIGINFO"; + + type MultipleResolveType = 'resolve' | 'reject'; + + type BeforeExitListener = (code: number) => void; + type DisconnectListener = () => void; + type ExitListener = (code: number) => void; + type RejectionHandledListener = (promise: Promise) => void; + type UncaughtExceptionListener = (error: Error) => void; + type UnhandledRejectionListener = (reason: {} | null | undefined, promise: Promise) => void; + type WarningListener = (warning: Error) => void; + type MessageListener = (message: any, sendHandle: any) => void; + type SignalsListener = (signal: Signals) => void; + type NewListenerListener = (type: string | symbol, listener: (...args: any[]) => void) => void; + type RemoveListenerListener = (type: string | symbol, listener: (...args: any[]) => void) => void; + type MultipleResolveListener = (type: MultipleResolveType, promise: Promise, value: any) => void; + + interface Socket extends ReadWriteStream { + isTTY?: true; + } + + // Alias for compatibility + interface ProcessEnv extends Dict {} + + interface HRTime { + (time?: [number, number]): [number, number]; + bigint(): bigint; + } + + interface ProcessReport { + /** + * Directory where the report is written. + * working directory of the Node.js process. + * @default '' indicating that reports are written to the current + */ + directory: string; + + /** + * Filename where the report is written. + * The default value is the empty string. + * @default '' the output filename will be comprised of a timestamp, + * PID, and sequence number. + */ + filename: string; + + /** + * Returns a JSON-formatted diagnostic report for the running process. + * The report's JavaScript stack trace is taken from err, if present. + */ + getReport(err?: Error): string; + + /** + * If true, a diagnostic report is generated on fatal errors, + * such as out of memory errors or failed C++ assertions. + * @default false + */ + reportOnFatalError: boolean; + + /** + * If true, a diagnostic report is generated when the process + * receives the signal specified by process.report.signal. + * @defaul false + */ + reportOnSignal: boolean; + + /** + * If true, a diagnostic report is generated on uncaught exception. + * @default false + */ + reportOnUncaughtException: boolean; + + /** + * The signal used to trigger the creation of a diagnostic report. + * @default 'SIGUSR2' + */ + signal: Signals; + + /** + * Writes a diagnostic report to a file. If filename is not provided, the default filename + * includes the date, time, PID, and a sequence number. + * The report's JavaScript stack trace is taken from err, if present. + * + * @param fileName Name of the file where the report is written. + * This should be a relative path, that will be appended to the directory specified in + * `process.report.directory`, or the current working directory of the Node.js process, + * if unspecified. + * @param error A custom error used for reporting the JavaScript stack. + * @return Filename of the generated report. + */ + writeReport(fileName?: string): string; + writeReport(error?: Error): string; + writeReport(fileName?: string, err?: Error): string; + } + + interface ResourceUsage { + fsRead: number; + fsWrite: number; + involuntaryContextSwitches: number; + ipcReceived: number; + ipcSent: number; + majorPageFault: number; + maxRSS: number; + minorPageFault: number; + sharedMemorySize: number; + signalsCount: number; + swappedOut: number; + systemCPUTime: number; + unsharedDataSize: number; + unsharedStackSize: number; + userCPUTime: number; + voluntaryContextSwitches: number; + } + + interface Process extends EventEmitter { + /** + * Can also be a tty.WriteStream, not typed due to limitations. + */ + stdout: WriteStream & { + fd: 1; + }; + /** + * Can also be a tty.WriteStream, not typed due to limitations. + */ + stderr: WriteStream & { + fd: 2; + }; + stdin: ReadStream & { + fd: 0; + }; + openStdin(): Socket; + argv: string[]; + argv0: string; + execArgv: string[]; + execPath: string; + abort(): void; + chdir(directory: string): void; + cwd(): string; + debugPort: number; + emitWarning(warning: string | Error, name?: string, ctor?: Function): void; + env: ProcessEnv; + exit(code?: number): never; + exitCode?: number; + getgid(): number; + setgid(id: number | string): void; + getuid(): number; + setuid(id: number | string): void; + geteuid(): number; + seteuid(id: number | string): void; + getegid(): number; + setegid(id: number | string): void; + getgroups(): number[]; + setgroups(groups: ReadonlyArray): void; + setUncaughtExceptionCaptureCallback(cb: ((err: Error) => void) | null): void; + hasUncaughtExceptionCaptureCallback(): boolean; + version: string; + versions: ProcessVersions; + config: { + target_defaults: { + cflags: any[]; + default_configuration: string; + defines: string[]; + include_dirs: string[]; + libraries: string[]; + }; + variables: { + clang: number; + host_arch: string; + node_install_npm: boolean; + node_install_waf: boolean; + node_prefix: string; + node_shared_openssl: boolean; + node_shared_v8: boolean; + node_shared_zlib: boolean; + node_use_dtrace: boolean; + node_use_etw: boolean; + node_use_openssl: boolean; + target_arch: string; + v8_no_strict_aliasing: number; + v8_use_snapshot: boolean; + visibility: string; + }; + }; + kill(pid: number, signal?: string | number): true; + pid: number; + ppid: number; + title: string; + arch: string; + platform: Platform; + /** @deprecated since v14.0.0 - use `require.main` instead. */ + mainModule?: Module; + memoryUsage(): MemoryUsage; + cpuUsage(previousValue?: CpuUsage): CpuUsage; + nextTick(callback: Function, ...args: any[]): void; + release: ProcessRelease; + features: { + inspector: boolean; + debug: boolean; + uv: boolean; + ipv6: boolean; + tls_alpn: boolean; + tls_sni: boolean; + tls_ocsp: boolean; + tls: boolean; + }; + /** + * @deprecated since v14.0.0 - Calling process.umask() with no argument causes + * the process-wide umask to be written twice. This introduces a race condition between threads, + * and is a potential security vulnerability. There is no safe, cross-platform alternative API. + */ + umask(): number; + /** + * Can only be set if not in worker thread. + */ + umask(mask: string | number): number; + uptime(): number; + hrtime: HRTime; + domain: Domain; + + // Worker + send?(message: any, sendHandle?: any, options?: { swallowErrors?: boolean}, callback?: (error: Error | null) => void): boolean; + disconnect(): void; + connected: boolean; + + /** + * The `process.allowedNodeEnvironmentFlags` property is a special, + * read-only `Set` of flags allowable within the [`NODE_OPTIONS`][] + * environment variable. + */ + allowedNodeEnvironmentFlags: ReadonlySet; + + /** + * Only available with `--experimental-report` + */ + report?: ProcessReport; + + resourceUsage(): ResourceUsage; + + traceDeprecation: boolean; + + /* EventEmitter */ + addListener(event: "beforeExit", listener: BeforeExitListener): this; + addListener(event: "disconnect", listener: DisconnectListener): this; + addListener(event: "exit", listener: ExitListener): this; + addListener(event: "rejectionHandled", listener: RejectionHandledListener): this; + addListener(event: "uncaughtException", listener: UncaughtExceptionListener): this; + addListener(event: "uncaughtExceptionMonitor", listener: UncaughtExceptionListener): this; + addListener(event: "unhandledRejection", listener: UnhandledRejectionListener): this; + addListener(event: "warning", listener: WarningListener): this; + addListener(event: "message", listener: MessageListener): this; + addListener(event: Signals, listener: SignalsListener): this; + addListener(event: "newListener", listener: NewListenerListener): this; + addListener(event: "removeListener", listener: RemoveListenerListener): this; + addListener(event: "multipleResolves", listener: MultipleResolveListener): this; + + emit(event: "beforeExit", code: number): boolean; + emit(event: "disconnect"): boolean; + emit(event: "exit", code: number): boolean; + emit(event: "rejectionHandled", promise: Promise): boolean; + emit(event: "uncaughtException", error: Error): boolean; + emit(event: "uncaughtExceptionMonitor", error: Error): boolean; + emit(event: "unhandledRejection", reason: any, promise: Promise): boolean; + emit(event: "warning", warning: Error): boolean; + emit(event: "message", message: any, sendHandle: any): this; + emit(event: Signals, signal: Signals): boolean; + emit(event: "newListener", eventName: string | symbol, listener: (...args: any[]) => void): this; + emit(event: "removeListener", eventName: string, listener: (...args: any[]) => void): this; + emit(event: "multipleResolves", listener: MultipleResolveListener): this; + + on(event: "beforeExit", listener: BeforeExitListener): this; + on(event: "disconnect", listener: DisconnectListener): this; + on(event: "exit", listener: ExitListener): this; + on(event: "rejectionHandled", listener: RejectionHandledListener): this; + on(event: "uncaughtException", listener: UncaughtExceptionListener): this; + on(event: "uncaughtExceptionMonitor", listener: UncaughtExceptionListener): this; + on(event: "unhandledRejection", listener: UnhandledRejectionListener): this; + on(event: "warning", listener: WarningListener): this; + on(event: "message", listener: MessageListener): this; + on(event: Signals, listener: SignalsListener): this; + on(event: "newListener", listener: NewListenerListener): this; + on(event: "removeListener", listener: RemoveListenerListener): this; + on(event: "multipleResolves", listener: MultipleResolveListener): this; + on(event: string | symbol, listener: (...args: any[]) => void): this; + + once(event: "beforeExit", listener: BeforeExitListener): this; + once(event: "disconnect", listener: DisconnectListener): this; + once(event: "exit", listener: ExitListener): this; + once(event: "rejectionHandled", listener: RejectionHandledListener): this; + once(event: "uncaughtException", listener: UncaughtExceptionListener): this; + once(event: "uncaughtExceptionMonitor", listener: UncaughtExceptionListener): this; + once(event: "unhandledRejection", listener: UnhandledRejectionListener): this; + once(event: "warning", listener: WarningListener): this; + once(event: "message", listener: MessageListener): this; + once(event: Signals, listener: SignalsListener): this; + once(event: "newListener", listener: NewListenerListener): this; + once(event: "removeListener", listener: RemoveListenerListener): this; + once(event: "multipleResolves", listener: MultipleResolveListener): this; + + prependListener(event: "beforeExit", listener: BeforeExitListener): this; + prependListener(event: "disconnect", listener: DisconnectListener): this; + prependListener(event: "exit", listener: ExitListener): this; + prependListener(event: "rejectionHandled", listener: RejectionHandledListener): this; + prependListener(event: "uncaughtException", listener: UncaughtExceptionListener): this; + prependListener(event: "uncaughtExceptionMonitor", listener: UncaughtExceptionListener): this; + prependListener(event: "unhandledRejection", listener: UnhandledRejectionListener): this; + prependListener(event: "warning", listener: WarningListener): this; + prependListener(event: "message", listener: MessageListener): this; + prependListener(event: Signals, listener: SignalsListener): this; + prependListener(event: "newListener", listener: NewListenerListener): this; + prependListener(event: "removeListener", listener: RemoveListenerListener): this; + prependListener(event: "multipleResolves", listener: MultipleResolveListener): this; + + prependOnceListener(event: "beforeExit", listener: BeforeExitListener): this; + prependOnceListener(event: "disconnect", listener: DisconnectListener): this; + prependOnceListener(event: "exit", listener: ExitListener): this; + prependOnceListener(event: "rejectionHandled", listener: RejectionHandledListener): this; + prependOnceListener(event: "uncaughtException", listener: UncaughtExceptionListener): this; + prependOnceListener(event: "uncaughtExceptionMonitor", listener: UncaughtExceptionListener): this; + prependOnceListener(event: "unhandledRejection", listener: UnhandledRejectionListener): this; + prependOnceListener(event: "warning", listener: WarningListener): this; + prependOnceListener(event: "message", listener: MessageListener): this; + prependOnceListener(event: Signals, listener: SignalsListener): this; + prependOnceListener(event: "newListener", listener: NewListenerListener): this; + prependOnceListener(event: "removeListener", listener: RemoveListenerListener): this; + prependOnceListener(event: "multipleResolves", listener: MultipleResolveListener): this; + + listeners(event: "beforeExit"): BeforeExitListener[]; + listeners(event: "disconnect"): DisconnectListener[]; + listeners(event: "exit"): ExitListener[]; + listeners(event: "rejectionHandled"): RejectionHandledListener[]; + listeners(event: "uncaughtException"): UncaughtExceptionListener[]; + listeners(event: "uncaughtExceptionMonitor"): UncaughtExceptionListener[]; + listeners(event: "unhandledRejection"): UnhandledRejectionListener[]; + listeners(event: "warning"): WarningListener[]; + listeners(event: "message"): MessageListener[]; + listeners(event: Signals): SignalsListener[]; + listeners(event: "newListener"): NewListenerListener[]; + listeners(event: "removeListener"): RemoveListenerListener[]; + listeners(event: "multipleResolves"): MultipleResolveListener[]; + } + + interface Global { + process: Process; + } } } diff --git a/node_modules/@types/node/punycode.d.ts b/node_modules/@types/node/punycode.d.ts index 75d2811..2b771d4 100644 --- a/node_modules/@types/node/punycode.d.ts +++ b/node_modules/@types/node/punycode.d.ts @@ -1,12 +1,68 @@ declare module "punycode" { + /** + * @deprecated since v7.0.0 + * The version of the punycode module bundled in Node.js is being deprecated. + * In a future major version of Node.js this module will be removed. + * Users currently depending on the punycode module should switch to using + * the userland-provided Punycode.js module instead. + */ function decode(string: string): string; + /** + * @deprecated since v7.0.0 + * The version of the punycode module bundled in Node.js is being deprecated. + * In a future major version of Node.js this module will be removed. + * Users currently depending on the punycode module should switch to using + * the userland-provided Punycode.js module instead. + */ function encode(string: string): string; + /** + * @deprecated since v7.0.0 + * The version of the punycode module bundled in Node.js is being deprecated. + * In a future major version of Node.js this module will be removed. + * Users currently depending on the punycode module should switch to using + * the userland-provided Punycode.js module instead. + */ function toUnicode(domain: string): string; + /** + * @deprecated since v7.0.0 + * The version of the punycode module bundled in Node.js is being deprecated. + * In a future major version of Node.js this module will be removed. + * Users currently depending on the punycode module should switch to using + * the userland-provided Punycode.js module instead. + */ function toASCII(domain: string): string; + /** + * @deprecated since v7.0.0 + * The version of the punycode module bundled in Node.js is being deprecated. + * In a future major version of Node.js this module will be removed. + * Users currently depending on the punycode module should switch to using + * the userland-provided Punycode.js module instead. + */ const ucs2: ucs2; interface ucs2 { + /** + * @deprecated since v7.0.0 + * The version of the punycode module bundled in Node.js is being deprecated. + * In a future major version of Node.js this module will be removed. + * Users currently depending on the punycode module should switch to using + * the userland-provided Punycode.js module instead. + */ decode(string: string): number[]; - encode(codePoints: number[]): string; + /** + * @deprecated since v7.0.0 + * The version of the punycode module bundled in Node.js is being deprecated. + * In a future major version of Node.js this module will be removed. + * Users currently depending on the punycode module should switch to using + * the userland-provided Punycode.js module instead. + */ + encode(codePoints: ReadonlyArray): string; } + /** + * @deprecated since v7.0.0 + * The version of the punycode module bundled in Node.js is being deprecated. + * In a future major version of Node.js this module will be removed. + * Users currently depending on the punycode module should switch to using + * the userland-provided Punycode.js module instead. + */ const version: string; } diff --git a/node_modules/@types/node/querystring.d.ts b/node_modules/@types/node/querystring.d.ts index a61269d..3e204e7 100644 --- a/node_modules/@types/node/querystring.d.ts +++ b/node_modules/@types/node/querystring.d.ts @@ -8,10 +8,9 @@ declare module "querystring" { decodeURIComponent?: (str: string) => string; } - interface ParsedUrlQuery { [key: string]: string | string[]; } + interface ParsedUrlQuery extends NodeJS.Dict { } - interface ParsedUrlQueryInput { - [key: string]: NodeJS.PoorMansUnknown; + interface ParsedUrlQueryInput extends NodeJS.Dict | ReadonlyArray | ReadonlyArray | null> { } function stringify(obj?: ParsedUrlQueryInput, sep?: string, eq?: string, options?: StringifyOptions): string; diff --git a/node_modules/@types/node/readline.d.ts b/node_modules/@types/node/readline.d.ts index 6cb572e..fbe4836 100644 --- a/node_modules/@types/node/readline.d.ts +++ b/node_modules/@types/node/readline.d.ts @@ -13,6 +13,13 @@ declare module "readline" { class Interface extends events.EventEmitter { readonly terminal: boolean; + // Need direct access to line/cursor data, for use in external processes + // see: https://github.com/nodejs/node/issues/30347 + /** The current input data */ + readonly line: string; + /** The current cursor position in the input line */ + readonly cursor: number; + /** * NOTE: According to the documentation: * @@ -40,6 +47,13 @@ declare module "readline" { close(): void; write(data: string | Buffer, key?: Key): void; + /** + * Returns the real position of the cursor in relation to the input + * prompt + string. Long input (wrapping) strings, as well as multiple + * line prompts are included in the calculations. + */ + getCursorPos(): CursorPos; + /** * events.EventEmitter * 1. close @@ -123,6 +137,8 @@ declare module "readline" { prompt?: string; crlfDelay?: number; removeHistoryDuplicates?: boolean; + escapeCodeTimeout?: number; + tabSize?: number; } function createInterface(input: NodeJS.ReadableStream, output?: NodeJS.WritableStream, completer?: Completer | AsyncCompleter, terminal?: boolean): Interface; @@ -131,6 +147,11 @@ declare module "readline" { type Direction = -1 | 0 | 1; + interface CursorPos { + rows: number; + cols: number; + } + /** * Clears the current line of this WriteStream in a direction identified by `dir`. */ diff --git a/node_modules/@types/node/repl.d.ts b/node_modules/@types/node/repl.d.ts index 9496fcd..4985b52 100644 --- a/node_modules/@types/node/repl.d.ts +++ b/node_modules/@types/node/repl.d.ts @@ -36,6 +36,11 @@ declare module "repl" { * @see https://nodejs.org/dist/latest-v10.x/docs/api/repl.html#repl_custom_evaluation_functions */ eval?: REPLEval; + /** + * Defines if the repl prints output previews or not. + * @default `true` Always `false` in case `terminal` is falsy. + */ + preview?: boolean; /** * If `true`, specifies that the default `writer` function should include ANSI color * styling to REPL output. If a custom `writer` function is provided then this has no @@ -131,17 +136,25 @@ declare module "repl" { */ readonly context: Context; /** - * The `Readable` stream from which REPL input will be read. + * @deprecated since v14.3.0 - Use `input` instead. */ readonly inputStream: NodeJS.ReadableStream; /** - * The `Writable` stream to which REPL output will be written. + * @deprecated since v14.3.0 - Use `output` instead. */ readonly outputStream: NodeJS.WritableStream; + /** + * The `Readable` stream from which REPL input will be read. + */ + readonly input: NodeJS.ReadableStream; + /** + * The `Writable` stream to which REPL output will be written. + */ + readonly output: NodeJS.WritableStream; /** * The commands registered via `replServer.defineCommand()`. */ - readonly commands: { readonly [name: string]: REPLCommand | undefined }; + readonly commands: NodeJS.ReadOnlyDict; /** * A value indicating whether the REPL is currently in "editor mode". * @@ -353,13 +366,13 @@ declare module "repl" { /** * A flag passed in the REPL options. Evaluates expressions in sloppy mode. */ - const REPL_MODE_SLOPPY: symbol; // TODO: unique symbol + const REPL_MODE_SLOPPY: unique symbol; /** * A flag passed in the REPL options. Evaluates expressions in strict mode. * This is equivalent to prefacing every repl statement with `'use strict'`. */ - const REPL_MODE_STRICT: symbol; // TODO: unique symbol + const REPL_MODE_STRICT: unique symbol; /** * Creates and starts a `repl.REPLServer` instance. diff --git a/node_modules/@types/node/stream.d.ts b/node_modules/@types/node/stream.d.ts index 2a0895b..7e189d9 100644 --- a/node_modules/@types/node/stream.d.ts +++ b/node_modules/@types/node/stream.d.ts @@ -6,11 +6,13 @@ declare module "stream" { } namespace internal { - class Stream extends internal { } + class Stream extends internal { + constructor(opts?: ReadableOptions); + } interface ReadableOptions { highWaterMark?: number; - encoding?: string; + encoding?: BufferEncoding; objectMode?: boolean; read?(this: Readable, size: number): void; destroy?(this: Readable, error: Error | null, callback: (error: Error | null) => void): void; @@ -24,6 +26,9 @@ declare module "stream" { static from(iterable: Iterable | AsyncIterable, options?: ReadableOptions): Readable; readable: boolean; + readonly readableEncoding: BufferEncoding | null; + readonly readableEnded: boolean; + readonly readableFlowing: boolean | null; readonly readableHighWaterMark: number; readonly readableLength: number; readonly readableObjectMode: boolean; @@ -31,14 +36,14 @@ declare module "stream" { constructor(opts?: ReadableOptions); _read(size: number): void; read(size?: number): any; - setEncoding(encoding: string): this; + setEncoding(encoding: BufferEncoding): this; pause(): this; resume(): this; isPaused(): boolean; unpipe(destination?: NodeJS.WritableStream): this; unshift(chunk: any, encoding?: BufferEncoding): void; wrap(oldStream: NodeJS.ReadableStream): this; - push(chunk: any, encoding?: string): boolean; + push(chunk: any, encoding?: BufferEncoding): boolean; _destroy(error: Error | null, callback: (error?: Error | null) => void): void; destroy(error?: Error): void; @@ -48,56 +53,72 @@ declare module "stream" { * 1. close * 2. data * 3. end - * 4. readable - * 5. error + * 4. error + * 5. pause + * 6. readable + * 7. resume */ addListener(event: "close", listener: () => void): this; addListener(event: "data", listener: (chunk: any) => void): this; addListener(event: "end", listener: () => void): this; - addListener(event: "readable", listener: () => void): this; addListener(event: "error", listener: (err: Error) => void): this; + addListener(event: "pause", listener: () => void): this; + addListener(event: "readable", listener: () => void): this; + addListener(event: "resume", listener: () => void): this; addListener(event: string | symbol, listener: (...args: any[]) => void): this; emit(event: "close"): boolean; emit(event: "data", chunk: any): boolean; emit(event: "end"): boolean; - emit(event: "readable"): boolean; emit(event: "error", err: Error): boolean; + emit(event: "pause"): boolean; + emit(event: "readable"): boolean; + emit(event: "resume"): boolean; emit(event: string | symbol, ...args: any[]): boolean; on(event: "close", listener: () => void): this; on(event: "data", listener: (chunk: any) => void): this; on(event: "end", listener: () => void): this; - on(event: "readable", listener: () => void): this; on(event: "error", listener: (err: Error) => void): this; + on(event: "pause", listener: () => void): this; + on(event: "readable", listener: () => void): this; + on(event: "resume", listener: () => void): this; on(event: string | symbol, listener: (...args: any[]) => void): this; once(event: "close", listener: () => void): this; once(event: "data", listener: (chunk: any) => void): this; once(event: "end", listener: () => void): this; - once(event: "readable", listener: () => void): this; once(event: "error", listener: (err: Error) => void): this; + once(event: "pause", listener: () => void): this; + once(event: "readable", listener: () => void): this; + once(event: "resume", listener: () => void): this; once(event: string | symbol, listener: (...args: any[]) => void): this; prependListener(event: "close", listener: () => void): this; prependListener(event: "data", listener: (chunk: any) => void): this; prependListener(event: "end", listener: () => void): this; - prependListener(event: "readable", listener: () => void): this; prependListener(event: "error", listener: (err: Error) => void): this; + prependListener(event: "pause", listener: () => void): this; + prependListener(event: "readable", listener: () => void): this; + prependListener(event: "resume", listener: () => void): this; prependListener(event: string | symbol, listener: (...args: any[]) => void): this; prependOnceListener(event: "close", listener: () => void): this; prependOnceListener(event: "data", listener: (chunk: any) => void): this; prependOnceListener(event: "end", listener: () => void): this; - prependOnceListener(event: "readable", listener: () => void): this; prependOnceListener(event: "error", listener: (err: Error) => void): this; + prependOnceListener(event: "pause", listener: () => void): this; + prependOnceListener(event: "readable", listener: () => void): this; + prependOnceListener(event: "resume", listener: () => void): this; prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this; removeListener(event: "close", listener: () => void): this; removeListener(event: "data", listener: (chunk: any) => void): this; removeListener(event: "end", listener: () => void): this; - removeListener(event: "readable", listener: () => void): this; removeListener(event: "error", listener: (err: Error) => void): this; + removeListener(event: "pause", listener: () => void): this; + removeListener(event: "readable", listener: () => void): this; + removeListener(event: "resume", listener: () => void): this; removeListener(event: string | symbol, listener: (...args: any[]) => void): this; [Symbol.asyncIterator](): AsyncIterableIterator; @@ -106,11 +127,11 @@ declare module "stream" { interface WritableOptions { highWaterMark?: number; decodeStrings?: boolean; - defaultEncoding?: string; + defaultEncoding?: BufferEncoding; objectMode?: boolean; emitClose?: boolean; - write?(this: Writable, chunk: any, encoding: string, callback: (error?: Error | null) => void): void; - writev?(this: Writable, chunks: Array<{ chunk: any, encoding: string }>, callback: (error?: Error | null) => void): void; + write?(this: Writable, chunk: any, encoding: BufferEncoding, callback: (error?: Error | null) => void): void; + writev?(this: Writable, chunks: Array<{ chunk: any, encoding: BufferEncoding }>, callback: (error?: Error | null) => void): void; destroy?(this: Writable, error: Error | null, callback: (error: Error | null) => void): void; final?(this: Writable, callback: (error?: Error | null) => void): void; autoDestroy?: boolean; @@ -123,18 +144,19 @@ declare module "stream" { readonly writableHighWaterMark: number; readonly writableLength: number; readonly writableObjectMode: boolean; + readonly writableCorked: number; destroyed: boolean; constructor(opts?: WritableOptions); - _write(chunk: any, encoding: string, callback: (error?: Error | null) => void): void; - _writev?(chunks: Array<{ chunk: any, encoding: string }>, callback: (error?: Error | null) => void): void; + _write(chunk: any, encoding: BufferEncoding, callback: (error?: Error | null) => void): void; + _writev?(chunks: Array<{ chunk: any, encoding: BufferEncoding }>, callback: (error?: Error | null) => void): void; _destroy(error: Error | null, callback: (error?: Error | null) => void): void; _final(callback: (error?: Error | null) => void): void; write(chunk: any, cb?: (error: Error | null | undefined) => void): boolean; - write(chunk: any, encoding: string, cb?: (error: Error | null | undefined) => void): boolean; - setDefaultEncoding(encoding: string): this; + write(chunk: any, encoding: BufferEncoding, cb?: (error: Error | null | undefined) => void): boolean; + setDefaultEncoding(encoding: BufferEncoding): this; end(cb?: () => void): void; end(chunk: any, cb?: () => void): void; - end(chunk: any, encoding: string, cb?: () => void): void; + end(chunk: any, encoding: BufferEncoding, cb?: () => void): void; cork(): void; uncork(): void; destroy(error?: Error): void; @@ -210,9 +232,12 @@ declare module "stream" { allowHalfOpen?: boolean; readableObjectMode?: boolean; writableObjectMode?: boolean; + readableHighWaterMark?: number; + writableHighWaterMark?: number; + writableCorked?: number; read?(this: Duplex, size: number): void; - write?(this: Duplex, chunk: any, encoding: string, callback: (error?: Error | null) => void): void; - writev?(this: Duplex, chunks: Array<{ chunk: any, encoding: string }>, callback: (error?: Error | null) => void): void; + write?(this: Duplex, chunk: any, encoding: BufferEncoding, callback: (error?: Error | null) => void): void; + writev?(this: Duplex, chunks: Array<{ chunk: any, encoding: BufferEncoding }>, callback: (error?: Error | null) => void): void; final?(this: Duplex, callback: (error?: Error | null) => void): void; destroy?(this: Duplex, error: Error | null, callback: (error: Error | null) => void): void; } @@ -225,17 +250,18 @@ declare module "stream" { readonly writableHighWaterMark: number; readonly writableLength: number; readonly writableObjectMode: boolean; + readonly writableCorked: number; constructor(opts?: DuplexOptions); - _write(chunk: any, encoding: string, callback: (error?: Error | null) => void): void; - _writev?(chunks: Array<{ chunk: any, encoding: string }>, callback: (error?: Error | null) => void): void; + _write(chunk: any, encoding: BufferEncoding, callback: (error?: Error | null) => void): void; + _writev?(chunks: Array<{ chunk: any, encoding: BufferEncoding }>, callback: (error?: Error | null) => void): void; _destroy(error: Error | null, callback: (error: Error | null) => void): void; _final(callback: (error?: Error | null) => void): void; - write(chunk: any, encoding?: string, cb?: (error: Error | null | undefined) => void): boolean; + write(chunk: any, encoding?: BufferEncoding, cb?: (error: Error | null | undefined) => void): boolean; write(chunk: any, cb?: (error: Error | null | undefined) => void): boolean; - setDefaultEncoding(encoding: string): this; + setDefaultEncoding(encoding: BufferEncoding): this; end(cb?: () => void): void; end(chunk: any, cb?: () => void): void; - end(chunk: any, encoding?: string, cb?: () => void): void; + end(chunk: any, encoding?: BufferEncoding, cb?: () => void): void; cork(): void; uncork(): void; } @@ -244,25 +270,31 @@ declare module "stream" { interface TransformOptions extends DuplexOptions { read?(this: Transform, size: number): void; - write?(this: Transform, chunk: any, encoding: string, callback: (error?: Error | null) => void): void; - writev?(this: Transform, chunks: Array<{ chunk: any, encoding: string }>, callback: (error?: Error | null) => void): void; + write?(this: Transform, chunk: any, encoding: BufferEncoding, callback: (error?: Error | null) => void): void; + writev?(this: Transform, chunks: Array<{ chunk: any, encoding: BufferEncoding }>, callback: (error?: Error | null) => void): void; final?(this: Transform, callback: (error?: Error | null) => void): void; destroy?(this: Transform, error: Error | null, callback: (error: Error | null) => void): void; - transform?(this: Transform, chunk: any, encoding: string, callback: TransformCallback): void; + transform?(this: Transform, chunk: any, encoding: BufferEncoding, callback: TransformCallback): void; flush?(this: Transform, callback: TransformCallback): void; } class Transform extends Duplex { constructor(opts?: TransformOptions); - _transform(chunk: any, encoding: string, callback: TransformCallback): void; + _transform(chunk: any, encoding: BufferEncoding, callback: TransformCallback): void; _flush(callback: TransformCallback): void; } class PassThrough extends Transform { } + interface FinishedOptions { + error?: boolean; + readable?: boolean; + writable?: boolean; + } + function finished(stream: NodeJS.ReadableStream | NodeJS.WritableStream | NodeJS.ReadWriteStream, options: FinishedOptions, callback: (err?: NodeJS.ErrnoException | null) => void): () => void; function finished(stream: NodeJS.ReadableStream | NodeJS.WritableStream | NodeJS.ReadWriteStream, callback: (err?: NodeJS.ErrnoException | null) => void): () => void; namespace finished { - function __promisify__(stream: NodeJS.ReadableStream | NodeJS.WritableStream | NodeJS.ReadWriteStream): Promise; + function __promisify__(stream: NodeJS.ReadableStream | NodeJS.WritableStream | NodeJS.ReadWriteStream, options?: FinishedOptions): Promise; } function pipeline(stream1: NodeJS.ReadableStream, stream2: T, callback?: (err: NodeJS.ErrnoException | null) => void): T; @@ -282,7 +314,10 @@ declare module "stream" { stream5: T, callback?: (err: NodeJS.ErrnoException | null) => void, ): T; - function pipeline(streams: Array, callback?: (err: NodeJS.ErrnoException | null) => void): NodeJS.WritableStream; + function pipeline( + streams: ReadonlyArray, + callback?: (err: NodeJS.ErrnoException | null) => void, + ): NodeJS.WritableStream; function pipeline( stream1: NodeJS.ReadableStream, stream2: NodeJS.ReadWriteStream | NodeJS.WritableStream, @@ -299,7 +334,7 @@ declare module "stream" { stream4: NodeJS.ReadWriteStream, stream5: NodeJS.WritableStream, ): Promise; - function __promisify__(streams: Array): Promise; + function __promisify__(streams: ReadonlyArray): Promise; function __promisify__( stream1: NodeJS.ReadableStream, stream2: NodeJS.ReadWriteStream | NodeJS.WritableStream, diff --git a/node_modules/@types/node/string_decoder.d.ts b/node_modules/@types/node/string_decoder.d.ts index fe0e0b4..a6a4060 100644 --- a/node_modules/@types/node/string_decoder.d.ts +++ b/node_modules/@types/node/string_decoder.d.ts @@ -1,6 +1,6 @@ declare module "string_decoder" { class StringDecoder { - constructor(encoding?: string); + constructor(encoding?: BufferEncoding); write(buffer: Buffer): string; end(buffer?: Buffer): string; } diff --git a/node_modules/@types/node/tls.d.ts b/node_modules/@types/node/tls.d.ts index 2ff817b..6092a6e 100644 --- a/node_modules/@types/node/tls.d.ts +++ b/node_modules/@types/node/tls.d.ts @@ -38,12 +38,13 @@ declare module "tls" { subject: Certificate; issuer: Certificate; subjectaltname: string; - infoAccess: { [index: string]: string[] | undefined }; + infoAccess: NodeJS.Dict; modulus: string; exponent: string; valid_from: string; valid_to: string; fingerprint: string; + fingerprint256: string; ext_key_usage: string[]; serialNumber: string; raw: Buffer; @@ -62,6 +63,48 @@ declare module "tls" { * SSL/TLS protocol version. */ version: string; + + /** + * IETF name for the cipher suite. + */ + standardName: string; + } + + interface EphemeralKeyInfo { + /** + * The supported types are 'DH' and 'ECDH'. + */ + type: string; + /** + * The name property is available only when type is 'ECDH'. + */ + name?: string; + /** + * The size of parameter of an ephemeral key exchange. + */ + size: number; + } + + interface KeyObject { + /** + * Private keys in PEM format. + */ + pem: string | Buffer; + /** + * Optional passphrase. + */ + passphrase?: string; + } + + interface PxfObject { + /** + * PFX or PKCS12 encoded private key and certificate chain. + */ + buf: string | Buffer; + /** + * Optional passphrase. + */ + passphrase?: string; } interface TLSSocketOptions extends SecureContextOptions, CommonConnectionOptions { @@ -114,12 +157,50 @@ declare module "tls" { */ alpnProtocol?: string; + /** + * Returns an object representing the local certificate. The returned + * object has some properties corresponding to the fields of the + * certificate. + * + * See tls.TLSSocket.getPeerCertificate() for an example of the + * certificate structure. + * + * If there is no local certificate, an empty object will be returned. + * If the socket has been destroyed, null will be returned. + */ + getCertificate(): PeerCertificate | object | null; /** * Returns an object representing the cipher name and the SSL/TLS protocol version of the current connection. * @returns Returns an object representing the cipher name * and the SSL/TLS protocol version of the current connection. */ getCipher(): CipherNameAndProtocol; + /** + * Returns an object representing the type, name, and size of parameter + * of an ephemeral key exchange in Perfect Forward Secrecy on a client + * connection. It returns an empty object when the key exchange is not + * ephemeral. As this is only supported on a client socket; null is + * returned if called on a server socket. The supported types are 'DH' + * and 'ECDH'. The name property is available only when type is 'ECDH'. + * + * For example: { type: 'ECDH', name: 'prime256v1', size: 256 }. + */ + getEphemeralKeyInfo(): EphemeralKeyInfo | object | null; + /** + * Returns the latest Finished message that has + * been sent to the socket as part of a SSL/TLS handshake, or undefined + * if no Finished message has been sent yet. + * + * As the Finished messages are message digests of the complete + * handshake (with a total of 192 bits for TLS 1.0 and more for SSL + * 3.0), they can be used for external authentication procedures when + * the authentication provided by SSL/TLS is not desired or is not + * enough. + * + * Corresponds to the SSL_get_finished routine in OpenSSL and may be + * used to implement the tls-unique channel binding from RFC 5929. + */ + getFinished(): Buffer | undefined; /** * Returns an object representing the peer's certificate. * The returned object has some properties corresponding to the field of the certificate. @@ -132,6 +213,21 @@ declare module "tls" { getPeerCertificate(detailed: true): DetailedPeerCertificate; getPeerCertificate(detailed?: false): PeerCertificate; getPeerCertificate(detailed?: boolean): PeerCertificate | DetailedPeerCertificate; + /** + * Returns the latest Finished message that is expected or has actually + * been received from the socket as part of a SSL/TLS handshake, or + * undefined if there is no Finished message so far. + * + * As the Finished messages are message digests of the complete + * handshake (with a total of 192 bits for TLS 1.0 and more for SSL + * 3.0), they can be used for external authentication procedures when + * the authentication provided by SSL/TLS is not desired or is not + * enough. + * + * Corresponds to the SSL_get_peer_finished routine in OpenSSL and may + * be used to implement the tls-unique channel binding from RFC 5929. + */ + getPeerFinished(): Buffer | undefined; /** * Returns a string containing the negotiated SSL/TLS protocol version of the current connection. * The value `'unknown'` will be returned for connected sockets that have not completed the handshaking process. @@ -145,12 +241,21 @@ declare module "tls" { * @returns ASN.1 encoded TLS session or undefined if none was negotiated. */ getSession(): Buffer | undefined; + /** + * Returns a list of signature algorithms shared between the server and + * the client in the order of decreasing preference. + */ + getSharedSigalgs(): string[]; /** * NOTE: Works only with client TLS sockets. * Useful only for debugging, for session reuse provide session option to tls.connect(). * @returns TLS session ticket or undefined if none was negotiated. */ getTLSTicket(): Buffer | undefined; + /** + * Returns true if the session was reused, false otherwise. + */ + isSessionReused(): boolean; /** * Initiate TLS renegotiation process. * @@ -175,6 +280,13 @@ declare module "tls" { */ setMaxSendFragment(size: number): boolean; + /** + * Disables TLS renegotiation for this TLSSocket instance. Once called, + * attempts to renegotiate will trigger an 'error' event on the + * TLSSocket. + */ + disableRenegotiation(): void; + /** * When enabled, TLS packet trace information is written to `stderr`. This can be * used to debug TLS connection problems. @@ -186,6 +298,14 @@ declare module "tls" { */ enableTrace(): void; + /** + * @param length number of bytes to retrieve from keying material + * @param label an application specific label, typically this will be a value from the + * [IANA Exporter Label Registry](https://www.iana.org/assignments/tls-parameters/tls-parameters.xhtml#exporter-labels). + * @param context optionally provide a context. + */ + exportKeyingMaterial(length: number, label: string, context: Buffer): Buffer; + addListener(event: string, listener: (...args: any[]) => void): this; addListener(event: "OCSPResponse", listener: (response: Buffer) => void): this; addListener(event: "secureConnect", listener: () => void): this; @@ -266,9 +386,57 @@ declare module "tls" { } interface TlsOptions extends SecureContextOptions, CommonConnectionOptions { + /** + * Abort the connection if the SSL/TLS handshake does not finish in the + * specified number of milliseconds. A 'tlsClientError' is emitted on + * the tls.Server object whenever a handshake times out. Default: + * 120000 (120 seconds). + */ handshakeTimeout?: number; + /** + * The number of seconds after which a TLS session created by the + * server will no longer be resumable. See Session Resumption for more + * information. Default: 300. + */ sessionTimeout?: number; + /** + * 48-bytes of cryptographically strong pseudo-random data. + */ ticketKeys?: Buffer; + + /** + * + * @param socket + * @param identity identity parameter sent from the client. + * @return pre-shared key that must either be + * a buffer or `null` to stop the negotiation process. Returned PSK must be + * compatible with the selected cipher's digest. + * + * When negotiating TLS-PSK (pre-shared keys), this function is called + * with the identity provided by the client. + * If the return value is `null` the negotiation process will stop and an + * "unknown_psk_identity" alert message will be sent to the other party. + * If the server wishes to hide the fact that the PSK identity was not known, + * the callback must provide some random data as `psk` to make the connection + * fail with "decrypt_error" before negotiation is finished. + * PSK ciphers are disabled by default, and using TLS-PSK thus + * requires explicitly specifying a cipher suite with the `ciphers` option. + * More information can be found in the RFC 4279. + */ + + pskCallback?(socket: TLSSocket, identity: string): DataView | NodeJS.TypedArray | null; + /** + * hint to send to a client to help + * with selecting the identity during TLS-PSK negotiation. Will be ignored + * in TLS 1.3. Upon failing to set pskIdentityHint `tlsClientError` will be + * emitted with `ERR_TLS_PSK_SET_IDENTIY_HINT_FAILED` code. + */ + pskIdentityHint?: string; + } + + interface PSKCallbackNegotation { + psk: DataView | NodeJS.TypedArray; + identitty: string; } interface ConnectionOptions extends SecureContextOptions, CommonConnectionOptions { @@ -282,10 +450,50 @@ declare module "tls" { minDHSize?: number; lookup?: net.LookupFunction; timeout?: number; + /** + * When negotiating TLS-PSK (pre-shared keys), this function is called + * with optional identity `hint` provided by the server or `null` + * in case of TLS 1.3 where `hint` was removed. + * It will be necessary to provide a custom `tls.checkServerIdentity()` + * for the connection as the default one will try to check hostname/IP + * of the server against the certificate but that's not applicable for PSK + * because there won't be a certificate present. + * More information can be found in the RFC 4279. + * + * @param hint message sent from the server to help client + * decide which identity to use during negotiation. + * Always `null` if TLS 1.3 is used. + * @returns Return `null` to stop the negotiation process. `psk` must be + * compatible with the selected cipher's digest. + * `identity` must use UTF-8 encoding. + */ + pskCallback?(hint: string | null): PSKCallbackNegotation | null; } class Server extends net.Server { + /** + * The server.addContext() method adds a secure context that will be + * used if the client request's SNI name matches the supplied hostname + * (or wildcard). + */ addContext(hostName: string, credentials: SecureContextOptions): void; + /** + * Returns the session ticket keys. + */ + getTicketKeys(): Buffer; + /** + * + * The server.setSecureContext() method replaces the + * secure context of an existing server. Existing connections to the + * server are not interrupted. + */ + setSecureContext(details: SecureContextOptions): void; + /** + * The server.setSecureContext() method replaces the secure context of + * an existing server. Existing connections to the server are not + * interrupted. + */ + setTicketKeys(keys: Buffer): void; /** * events.EventEmitter @@ -294,6 +502,7 @@ declare module "tls" { * 3. OCSPRequest * 4. resumeSession * 5. secureConnection + * 6. keylog */ addListener(event: string, listener: (...args: any[]) => void): this; addListener(event: "tlsClientError", listener: (err: Error, tlsSocket: TLSSocket) => void): this; @@ -352,20 +561,93 @@ declare module "tls" { type SecureVersion = 'TLSv1.3' | 'TLSv1.2' | 'TLSv1.1' | 'TLSv1'; interface SecureContextOptions { - pfx?: string | Buffer | Array; - key?: string | Buffer | Array; - passphrase?: string; - cert?: string | Buffer | Array; + /** + * Optionally override the trusted CA certificates. Default is to trust + * the well-known CAs curated by Mozilla. Mozilla's CAs are completely + * replaced when CAs are explicitly specified using this option. + */ ca?: string | Buffer | Array; + /** + * Cert chains in PEM format. One cert chain should be provided per + * private key. Each cert chain should consist of the PEM formatted + * certificate for a provided private key, followed by the PEM + * formatted intermediate certificates (if any), in order, and not + * including the root CA (the root CA must be pre-known to the peer, + * see ca). When providing multiple cert chains, they do not have to + * be in the same order as their private keys in key. If the + * intermediate certificates are not provided, the peer will not be + * able to validate the certificate, and the handshake will fail. + */ + cert?: string | Buffer | Array; + /** + * Colon-separated list of supported signature algorithms. The list + * can contain digest algorithms (SHA256, MD5 etc.), public key + * algorithms (RSA-PSS, ECDSA etc.), combination of both (e.g + * 'RSA+SHA384') or TLS v1.3 scheme names (e.g. rsa_pss_pss_sha512). + */ + sigalgs?: string; + /** + * Cipher suite specification, replacing the default. For more + * information, see modifying the default cipher suite. Permitted + * ciphers can be obtained via tls.getCiphers(). Cipher names must be + * uppercased in order for OpenSSL to accept them. + */ ciphers?: string; - honorCipherOrder?: boolean; - ecdhCurve?: string; + /** + * Name of an OpenSSL engine which can provide the client certificate. + */ clientCertEngine?: string; + /** + * PEM formatted CRLs (Certificate Revocation Lists). + */ crl?: string | Buffer | Array; + /** + * Diffie Hellman parameters, required for Perfect Forward Secrecy. Use + * openssl dhparam to create the parameters. The key length must be + * greater than or equal to 1024 bits or else an error will be thrown. + * Although 1024 bits is permissible, use 2048 bits or larger for + * stronger security. If omitted or invalid, the parameters are + * silently discarded and DHE ciphers will not be available. + */ dhparam?: string | Buffer; - secureOptions?: number; // Value is a numeric bitmask of the `SSL_OP_*` options - secureProtocol?: string; // SSL Method, e.g. SSLv23_method - sessionIdContext?: string; + /** + * A string describing a named curve or a colon separated list of curve + * NIDs or names, for example P-521:P-384:P-256, to use for ECDH key + * agreement. Set to auto to select the curve automatically. Use + * crypto.getCurves() to obtain a list of available curve names. On + * recent releases, openssl ecparam -list_curves will also display the + * name and description of each available elliptic curve. Default: + * tls.DEFAULT_ECDH_CURVE. + */ + ecdhCurve?: string; + /** + * Attempt to use the server's cipher suite preferences instead of the + * client's. When true, causes SSL_OP_CIPHER_SERVER_PREFERENCE to be + * set in secureOptions + */ + honorCipherOrder?: boolean; + /** + * Private keys in PEM format. PEM allows the option of private keys + * being encrypted. Encrypted keys will be decrypted with + * options.passphrase. Multiple keys using different algorithms can be + * provided either as an array of unencrypted key strings or buffers, + * or an array of objects in the form {pem: [, + * passphrase: ]}. The object form can only occur in an array. + * object.passphrase is optional. Encrypted keys will be decrypted with + * object.passphrase if provided, or options.passphrase if it is not. + */ + key?: string | Buffer | Array; + /** + * Name of an OpenSSL engine to get private key from. Should be used + * together with privateKeyIdentifier. + */ + privateKeyEngine?: string; + /** + * Identifier of a private key managed by an OpenSSL engine. Should be + * used together with privateKeyEngine. Should not be set together with + * key, because both options define a private key in different ways. + */ + privateKeyIdentifier?: string; /** * Optionally set the maximum TLS version to allow. One * of `'TLSv1.3'`, `'TLSv1.2'`, `'TLSv1.1'`, or `'TLSv1'`. Cannot be specified along with the @@ -386,6 +668,55 @@ declare module "tls" { * 'TLSv1.3'. If multiple of the options are provided, the lowest minimum is used. */ minVersion?: SecureVersion; + /** + * Shared passphrase used for a single private key and/or a PFX. + */ + passphrase?: string; + /** + * PFX or PKCS12 encoded private key and certificate chain. pfx is an + * alternative to providing key and cert individually. PFX is usually + * encrypted, if it is, passphrase will be used to decrypt it. Multiple + * PFX can be provided either as an array of unencrypted PFX buffers, + * or an array of objects in the form {buf: [, + * passphrase: ]}. The object form can only occur in an array. + * object.passphrase is optional. Encrypted PFX will be decrypted with + * object.passphrase if provided, or options.passphrase if it is not. + */ + pfx?: string | Buffer | Array; + /** + * Optionally affect the OpenSSL protocol behavior, which is not + * usually necessary. This should be used carefully if at all! Value is + * a numeric bitmask of the SSL_OP_* options from OpenSSL Options + */ + secureOptions?: number; // Value is a numeric bitmask of the `SSL_OP_*` options + /** + * Legacy mechanism to select the TLS protocol version to use, it does + * not support independent control of the minimum and maximum version, + * and does not support limiting the protocol to TLSv1.3. Use + * minVersion and maxVersion instead. The possible values are listed as + * SSL_METHODS, use the function names as strings. For example, use + * 'TLSv1_1_method' to force TLS version 1.1, or 'TLS_method' to allow + * any TLS protocol version up to TLSv1.3. It is not recommended to use + * TLS versions less than 1.2, but it may be required for + * interoperability. Default: none, see minVersion. + */ + secureProtocol?: string; + /** + * Opaque identifier used by servers to ensure session state is not + * shared between applications. Unused by clients. + */ + sessionIdContext?: string; + /** + * 48-bytes of cryptographically strong pseudo-random data. + * See Session Resumption for more information. + */ + ticketKeys?: Buffer; + /** + * The number of seconds after which a TLS session created by the + * server will no longer be resumable. See Session Resumption for more + * information. Default: 300. + */ + sessionTimeout?: number; } interface SecureContext { @@ -406,13 +737,43 @@ declare module "tls" { function connect(port: number, host?: string, options?: ConnectionOptions, secureConnectListener?: () => void): TLSSocket; function connect(port: number, options?: ConnectionOptions, secureConnectListener?: () => void): TLSSocket; /** - * @deprecated + * @deprecated since v0.11.3 Use `tls.TLSSocket` instead. */ function createSecurePair(credentials?: SecureContext, isServer?: boolean, requestCert?: boolean, rejectUnauthorized?: boolean): SecurePair; - function createSecureContext(details: SecureContextOptions): SecureContext; + function createSecureContext(options?: SecureContextOptions): SecureContext; function getCiphers(): string[]; - const DEFAULT_ECDH_CURVE: string; + /** + * The default curve name to use for ECDH key agreement in a tls server. + * The default value is 'auto'. See tls.createSecureContext() for further + * information. + */ + let DEFAULT_ECDH_CURVE: string; + /** + * The default value of the maxVersion option of + * tls.createSecureContext(). It can be assigned any of the supported TLS + * protocol versions, 'TLSv1.3', 'TLSv1.2', 'TLSv1.1', or 'TLSv1'. Default: + * 'TLSv1.3', unless changed using CLI options. Using --tls-max-v1.2 sets + * the default to 'TLSv1.2'. Using --tls-max-v1.3 sets the default to + * 'TLSv1.3'. If multiple of the options are provided, the highest maximum + * is used. + */ + let DEFAULT_MAX_VERSION: SecureVersion; + /** + * The default value of the minVersion option of tls.createSecureContext(). + * It can be assigned any of the supported TLS protocol versions, + * 'TLSv1.3', 'TLSv1.2', 'TLSv1.1', or 'TLSv1'. Default: 'TLSv1.2', unless + * changed using CLI options. Using --tls-min-v1.0 sets the default to + * 'TLSv1'. Using --tls-min-v1.1 sets the default to 'TLSv1.1'. Using + * --tls-min-v1.3 sets the default to 'TLSv1.3'. If multiple of the options + * are provided, the lowest minimum is used. + */ + let DEFAULT_MIN_VERSION: SecureVersion; + /** + * An immutable array of strings representing the root certificates (in PEM + * format) used for verifying peer certificates. This is the default value + * of the ca option to tls.createSecureContext(). + */ const rootCertificates: ReadonlyArray; } diff --git a/node_modules/@types/node/ts3.2/fs.d.ts b/node_modules/@types/node/ts3.2/fs.d.ts deleted file mode 100644 index 0a9eae0..0000000 --- a/node_modules/@types/node/ts3.2/fs.d.ts +++ /dev/null @@ -1,33 +0,0 @@ -// tslint:disable-next-line:no-bad-reference -/// - -declare module 'fs' { - interface BigIntStats extends StatsBase { - } - - class BigIntStats { - atimeNs: BigInt; - mtimeNs: BigInt; - ctimeNs: BigInt; - birthtimeNs: BigInt; - } - - interface BigIntOptions { - bigint: true; - } - - interface StatOptions { - bigint: boolean; - } - - function stat(path: PathLike, options: BigIntOptions, callback: (err: NodeJS.ErrnoException | null, stats: BigIntStats) => void): void; - function stat(path: PathLike, options: StatOptions, callback: (err: NodeJS.ErrnoException | null, stats: Stats | BigIntStats) => void): void; - - namespace stat { - function __promisify__(path: PathLike, options: BigIntOptions): Promise; - function __promisify__(path: PathLike, options: StatOptions): Promise; - } - - function statSync(path: PathLike, options: BigIntOptions): BigIntStats; - function statSync(path: PathLike, options: StatOptions): Stats | BigIntStats; -} diff --git a/node_modules/@types/node/ts3.2/globals.d.ts b/node_modules/@types/node/ts3.2/globals.d.ts deleted file mode 100644 index 70892bc..0000000 --- a/node_modules/@types/node/ts3.2/globals.d.ts +++ /dev/null @@ -1,19 +0,0 @@ -// tslint:disable-next-line:no-bad-reference -/// - -declare namespace NodeJS { - interface HRTime { - bigint(): bigint; - } -} - -interface Buffer extends Uint8Array { - readBigUInt64BE(offset?: number): bigint; - readBigUInt64LE(offset?: number): bigint; - readBigInt64BE(offset?: number): bigint; - readBigInt64LE(offset?: number): bigint; - writeBigInt64BE(value: bigint, offset?: number): number; - writeBigInt64LE(value: bigint, offset?: number): number; - writeBigUInt64BE(value: bigint, offset?: number): number; - writeBigUInt64LE(value: bigint, offset?: number): number; -} diff --git a/node_modules/@types/node/ts3.2/index.d.ts b/node_modules/@types/node/ts3.2/index.d.ts deleted file mode 100644 index ee07693..0000000 --- a/node_modules/@types/node/ts3.2/index.d.ts +++ /dev/null @@ -1,21 +0,0 @@ -// NOTE: These definitions support NodeJS and TypeScript 3.2. - -// NOTE: TypeScript version-specific augmentations can be found in the following paths: -// - ~/base.d.ts - Shared definitions common to all TypeScript versions -// - ~/index.d.ts - Definitions specific to TypeScript 2.1 -// - ~/ts3.2/index.d.ts - Definitions specific to TypeScript 3.2 - -// Reference required types from the default lib: -/// -/// -/// -/// - -// Base definitions for all NodeJS modules that are not specific to any version of TypeScript: -// tslint:disable-next-line:no-bad-reference -/// - -// TypeScript 3.2-specific augmentations: -/// -/// -/// diff --git a/node_modules/@types/node/ts3.2/util.d.ts b/node_modules/@types/node/ts3.2/util.d.ts deleted file mode 100644 index a8b2487..0000000 --- a/node_modules/@types/node/ts3.2/util.d.ts +++ /dev/null @@ -1,15 +0,0 @@ -// tslint:disable-next-line:no-bad-reference -/// - -declare module "util" { - namespace inspect { - const custom: unique symbol; - } - namespace promisify { - const custom: unique symbol; - } - namespace types { - function isBigInt64Array(value: any): value is BigInt64Array; - function isBigUint64Array(value: any): value is BigUint64Array; - } -} diff --git a/node_modules/@types/node/tty.d.ts b/node_modules/@types/node/tty.d.ts index 22bce21..7854366 100644 --- a/node_modules/@types/node/tty.d.ts +++ b/node_modules/@types/node/tty.d.ts @@ -5,7 +5,7 @@ declare module "tty" { class ReadStream extends net.Socket { constructor(fd: number, options?: net.SocketConstructorOpts); isRaw: boolean; - setRawMode(mode: boolean): void; + setRawMode(mode: boolean): this; isTTY: boolean; } /** diff --git a/node_modules/@types/node/url.d.ts b/node_modules/@types/node/url.d.ts index e5b7e28..2490c35 100644 --- a/node_modules/@types/node/url.d.ts +++ b/node_modules/@types/node/url.d.ts @@ -8,7 +8,6 @@ declare module "url" { host?: string | null; hostname?: string | null; href?: string | null; - path?: string | null; pathname?: string | null; protocol?: string | null; search?: string | null; @@ -93,7 +92,7 @@ declare module "url" { } class URLSearchParams implements Iterable<[string, string]> { - constructor(init?: URLSearchParams | string | { [key: string]: string | string[] | undefined } | Iterable<[string, string]> | Array<[string, string]>); + constructor(init?: URLSearchParams | string | NodeJS.Dict> | Iterable<[string, string]> | ReadonlyArray<[string, string]>); append(name: string, value: string): void; delete(name: string): void; entries(): IterableIterator<[string, string]>; diff --git a/node_modules/@types/node/util.d.ts b/node_modules/@types/node/util.d.ts index e0b6c89..f4d1bda 100644 --- a/node_modules/@types/node/util.d.ts +++ b/node_modules/@types/node/util.d.ts @@ -1,5 +1,10 @@ declare module "util" { interface InspectOptions extends NodeJS.InspectOptions { } + type Style = 'special' | 'number' | 'bigint' | 'boolean' | 'undefined' | 'null' | 'string' | 'symbol' | 'date' | 'regexp' | 'module'; + type CustomInspectFunction = (depth: number, options: InspectOptionsStylized) => string; + interface InspectOptionsStylized extends InspectOptions { + stylize(text: string, styleType: Style): string; + } function format(format: any, ...param: any[]): string; function formatWithOptions(inspectOptions: InspectOptions, format: string, ...param: any[]): string; /** @deprecated since v0.11.3 - use a third party module instead. */ @@ -7,17 +12,16 @@ declare module "util" { function inspect(object: any, showHidden?: boolean, depth?: number | null, color?: boolean): string; function inspect(object: any, options: InspectOptions): string; namespace inspect { - let colors: { - [color: string]: [number, number] | undefined - }; + let colors: NodeJS.Dict<[number, number]>; let styles: { - [style: string]: string | undefined + [K in Style]: string }; let defaultOptions: InspectOptions; /** * Allows changing inspect settings from the repl. */ let replDefaults: InspectOptions; + const custom: unique symbol; } /** @deprecated since v4.0.0 - use `Array.isArray()` instead. */ function isArray(object: any): object is any[]; @@ -54,10 +58,6 @@ declare module "util" { function deprecate(fn: T, message: string, code?: string): T; function isDeepStrictEqual(val1: any, val2: any): boolean; - interface CustomPromisify extends Function { - __promisify__: TCustom; - } - function callbackify(fn: () => Promise): (callback: (err: NodeJS.ErrnoException) => void) => void; function callbackify(fn: () => Promise): (callback: (err: NodeJS.ErrnoException, result: TResult) => void) => void; function callbackify(fn: (arg1: T1) => Promise): (arg1: T1, callback: (err: NodeJS.ErrnoException) => void) => void; @@ -83,6 +83,16 @@ declare module "util" { fn: (arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5, arg6: T6) => Promise ): (arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5, arg6: T6, callback: (err: NodeJS.ErrnoException | null, result: TResult) => void) => void; + interface CustomPromisifyLegacy extends Function { + __promisify__: TCustom; + } + + interface CustomPromisifySymbol extends Function { + [promisify.custom]: TCustom; + } + + type CustomPromisify = CustomPromisifySymbol | CustomPromisifyLegacy; + function promisify(fn: CustomPromisify): TCustom; function promisify(fn: (callback: (err: any, result: TResult) => void) => void): () => Promise; function promisify(fn: (callback: (err?: any) => void) => void): () => Promise; @@ -105,12 +115,18 @@ declare module "util" { fn: (arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5, callback: (err?: any) => void) => void, ): (arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5) => Promise; function promisify(fn: Function): Function; + namespace promisify { + const custom: unique symbol; + } namespace types { function isAnyArrayBuffer(object: any): boolean; function isArgumentsObject(object: any): object is IArguments; function isArrayBuffer(object: any): object is ArrayBuffer; + function isArrayBufferView(object: any): object is ArrayBufferView; function isAsyncFunction(object: any): boolean; + function isBigInt64Array(value: any): value is BigInt64Array; + function isBigUint64Array(value: any): value is BigUint64Array; function isBooleanObject(object: any): object is Boolean; function isBoxedPrimitive(object: any): object is (Number | Boolean | String | Symbol /* | Object(BigInt) | Object(Symbol) */); function isDataView(object: any): object is DataView; diff --git a/node_modules/@types/node/v8.d.ts b/node_modules/@types/node/v8.d.ts index 2e2706e..7d95082 100644 --- a/node_modules/@types/node/v8.d.ts +++ b/node_modules/@types/node/v8.d.ts @@ -64,9 +64,6 @@ declare module "v8" { function getHeapCodeStatistics(): HeapCodeStatistics; - /** - * @experimental - */ class Serializer { /** * Writes out a header, which includes the serialization format version. @@ -117,14 +114,10 @@ declare module "v8" { /** * A subclass of `Serializer` that serializes `TypedArray` (in particular `Buffer`) and `DataView` objects as host objects, * and only stores the part of their underlying `ArrayBuffers` that they are referring to. - * @experimental */ class DefaultSerializer extends Serializer { } - /** - * @experimental - */ class Deserializer { constructor(data: NodeJS.TypedArray); /** @@ -178,20 +171,17 @@ declare module "v8" { /** * A subclass of `Serializer` that serializes `TypedArray` (in particular `Buffer`) and `DataView` objects as host objects, * and only stores the part of their underlying `ArrayBuffers` that they are referring to. - * @experimental */ class DefaultDeserializer extends Deserializer { } /** * Uses a `DefaultSerializer` to serialize value into a buffer. - * @experimental */ function serialize(value: any): Buffer; /** * Uses a `DefaultDeserializer` with default options to read a JS value from a buffer. - * @experimental */ function deserialize(data: NodeJS.TypedArray): any; } diff --git a/node_modules/@types/node/vm.d.ts b/node_modules/@types/node/vm.d.ts index 208498c..399c2a6 100644 --- a/node_modules/@types/node/vm.d.ts +++ b/node_modules/@types/node/vm.d.ts @@ -1,7 +1,5 @@ declare module "vm" { - interface Context { - [key: string]: any; - } + interface Context extends NodeJS.Dict { } interface BaseOptions { /** * Specifies the filename used in stack traces produced by this script. @@ -43,6 +41,10 @@ declare module "vm" { * Default: `false`. */ breakOnSigint?: boolean; + /** + * If set to `afterEvaluate`, microtasks will be run immediately after the script has run. + */ + microtaskMode?: 'afterEvaluate'; } interface CompileFunctionOptions extends BaseOptions { /** @@ -94,6 +96,23 @@ declare module "vm" { }; } + type MeasureMemoryMode = 'summary' | 'detailed'; + + interface MeasureMemoryOptions { + /** + * @default 'summary' + */ + mode?: MeasureMemoryMode; + context?: Context; + } + + interface MemoryMeasurement { + total: { + jsMemoryEstimate: number; + jsMemoryRange: [number, number]; + }; + } + class Script { constructor(code: string, options?: ScriptOptions); runInContext(contextifiedSandbox: Context, options?: RunningScriptOptions): any; @@ -106,5 +125,22 @@ declare module "vm" { function runInContext(code: string, contextifiedSandbox: Context, options?: RunningScriptOptions | string): any; function runInNewContext(code: string, sandbox?: Context, options?: RunningScriptOptions | string): any; function runInThisContext(code: string, options?: RunningScriptOptions | string): any; - function compileFunction(code: string, params: string[], options: CompileFunctionOptions): Function; + function compileFunction(code: string, params?: ReadonlyArray, options?: CompileFunctionOptions): Function; + + /** + * Measure the memory known to V8 and used by the current execution context or a specified context. + * + * The format of the object that the returned Promise may resolve with is + * specific to the V8 engine and may change from one version of V8 to the next. + * + * The returned result is different from the statistics returned by + * `v8.getHeapSpaceStatistics()` in that `vm.measureMemory()` measures + * the memory reachable by V8 from a specific context, while + * `v8.getHeapSpaceStatistics()` measures the memory used by an instance + * of V8 engine, which can switch among multiple contexts that reference + * objects in the heap of one engine. + * + * @experimental + */ + function measureMemory(options?: MeasureMemoryOptions): Promise; } diff --git a/node_modules/@types/node/worker_threads.d.ts b/node_modules/@types/node/worker_threads.d.ts index 45ea85e..3a8881e 100644 --- a/node_modules/@types/node/worker_threads.d.ts +++ b/node_modules/@types/node/worker_threads.d.ts @@ -2,9 +2,13 @@ declare module "worker_threads" { import { Context } from "vm"; import { EventEmitter } from "events"; import { Readable, Writable } from "stream"; + import { URL } from "url"; + import { FileHandle } from "fs/promises"; const isMainThread: boolean; const parentPort: null | MessagePort; + const resourceLimits: ResourceLimits; + const SHARE_ENV: unique symbol; const threadId: number; const workerData: any; @@ -13,53 +17,97 @@ declare module "worker_threads" { readonly port2: MessagePort; } + type TransferListItem = ArrayBuffer | MessagePort | FileHandle; + class MessagePort extends EventEmitter { close(): void; - postMessage(value: any, transferList?: Array): void; + postMessage(value: any, transferList?: ReadonlyArray): void; ref(): void; unref(): void; start(): void; addListener(event: "close", listener: () => void): this; addListener(event: "message", listener: (value: any) => void): this; + addListener(event: "messageerror", listener: (error: Error) => void): this; addListener(event: string | symbol, listener: (...args: any[]) => void): this; emit(event: "close"): boolean; emit(event: "message", value: any): boolean; + emit(event: "messageerror", error: Error): boolean; emit(event: string | symbol, ...args: any[]): boolean; on(event: "close", listener: () => void): this; on(event: "message", listener: (value: any) => void): this; + on(event: "messageerror", listener: (error: Error) => void): this; on(event: string | symbol, listener: (...args: any[]) => void): this; once(event: "close", listener: () => void): this; once(event: "message", listener: (value: any) => void): this; + once(event: "messageerror", listener: (error: Error) => void): this; once(event: string | symbol, listener: (...args: any[]) => void): this; prependListener(event: "close", listener: () => void): this; prependListener(event: "message", listener: (value: any) => void): this; + prependListener(event: "messageerror", listener: (error: Error) => void): this; prependListener(event: string | symbol, listener: (...args: any[]) => void): this; prependOnceListener(event: "close", listener: () => void): this; prependOnceListener(event: "message", listener: (value: any) => void): this; + prependOnceListener(event: "messageerror", listener: (error: Error) => void): this; prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this; removeListener(event: "close", listener: () => void): this; removeListener(event: "message", listener: (value: any) => void): this; + removeListener(event: "messageerror", listener: (error: Error) => void): this; removeListener(event: string | symbol, listener: (...args: any[]) => void): this; off(event: "close", listener: () => void): this; off(event: "message", listener: (value: any) => void): this; + off(event: "messageerror", listener: (error: Error) => void): this; off(event: string | symbol, listener: (...args: any[]) => void): this; } interface WorkerOptions { + /** + * List of arguments which would be stringified and appended to + * `process.argv` in the worker. This is mostly similar to the `workerData` + * but the values will be available on the global `process.argv` as if they + * were passed as CLI options to the script. + */ + argv?: any[]; + env?: NodeJS.Dict | typeof SHARE_ENV; eval?: boolean; workerData?: any; stdin?: boolean; stdout?: boolean; stderr?: boolean; execArgv?: string[]; + resourceLimits?: ResourceLimits; + /** + * Additional data to send in the first worker message. + */ + transferList?: TransferListItem[]; + trackUnmanagedFds?: boolean; + } + + interface ResourceLimits { + /** + * The maximum size of a heap space for recently created objects. + */ + maxYoungGenerationSizeMb?: number; + /** + * The maximum size of the main heap in MB. + */ + maxOldGenerationSizeMb?: number; + /** + * The size of a pre-allocated memory range used for generated code. + */ + codeRangeSizeMb?: number; + /** + * The default maximum stack size for the thread. Small values may lead to unusable Worker instances. + * @default 4 + */ + stackSizeMb?: number; } class Worker extends EventEmitter { @@ -67,10 +115,16 @@ declare module "worker_threads" { readonly stdout: Readable; readonly stderr: Readable; readonly threadId: number; + readonly resourceLimits?: ResourceLimits; - constructor(filename: string, options?: WorkerOptions); + /** + * @param filename The path to the Worker’s main script or module. + * Must be either an absolute path or a relative path (i.e. relative to the current working directory) starting with ./ or ../, + * or a WHATWG URL object using file: protocol. If options.eval is true, this is a string containing JavaScript code rather than a path. + */ + constructor(filename: string | URL, options?: WorkerOptions); - postMessage(value: any, transferList?: Array): void; + postMessage(value: any, transferList?: ReadonlyArray): void; ref(): void; unref(): void; /** @@ -78,76 +132,107 @@ declare module "worker_threads" { * Returns a Promise for the exit code that is fulfilled when the `exit` event is emitted. */ terminate(): Promise; - /** - * Transfer a `MessagePort` to a different `vm` Context. The original `port` - * object will be rendered unusable, and the returned `MessagePort` instance will - * take its place. - * - * The returned `MessagePort` will be an object in the target context, and will - * inherit from its global `Object` class. Objects passed to the - * `port.onmessage()` listener will also be created in the target context - * and inherit from its global `Object` class. - * - * However, the created `MessagePort` will no longer inherit from - * `EventEmitter`, and only `port.onmessage()` can be used to receive - * events using it. - */ - moveMessagePortToContext(port: MessagePort, context: Context): MessagePort; /** - * Receive a single message from a given `MessagePort`. If no message is available, - * `undefined` is returned, otherwise an object with a single `message` property - * that contains the message payload, corresponding to the oldest message in the - * `MessagePort`’s queue. + * Returns a readable stream for a V8 snapshot of the current state of the Worker. + * See [`v8.getHeapSnapshot()`][] for more details. + * + * If the Worker thread is no longer running, which may occur before the + * [`'exit'` event][] is emitted, the returned `Promise` will be rejected + * immediately with an [`ERR_WORKER_NOT_RUNNING`][] error */ - receiveMessageOnPort(port: MessagePort): {} | undefined; + getHeapSnapshot(): Promise; addListener(event: "error", listener: (err: Error) => void): this; addListener(event: "exit", listener: (exitCode: number) => void): this; addListener(event: "message", listener: (value: any) => void): this; + addListener(event: "messageerror", listener: (error: Error) => void): this; addListener(event: "online", listener: () => void): this; addListener(event: string | symbol, listener: (...args: any[]) => void): this; emit(event: "error", err: Error): boolean; emit(event: "exit", exitCode: number): boolean; emit(event: "message", value: any): boolean; + emit(event: "messageerror", error: Error): boolean; emit(event: "online"): boolean; emit(event: string | symbol, ...args: any[]): boolean; on(event: "error", listener: (err: Error) => void): this; on(event: "exit", listener: (exitCode: number) => void): this; on(event: "message", listener: (value: any) => void): this; + on(event: "messageerror", listener: (error: Error) => void): this; on(event: "online", listener: () => void): this; on(event: string | symbol, listener: (...args: any[]) => void): this; once(event: "error", listener: (err: Error) => void): this; once(event: "exit", listener: (exitCode: number) => void): this; once(event: "message", listener: (value: any) => void): this; + once(event: "messageerror", listener: (error: Error) => void): this; once(event: "online", listener: () => void): this; once(event: string | symbol, listener: (...args: any[]) => void): this; prependListener(event: "error", listener: (err: Error) => void): this; prependListener(event: "exit", listener: (exitCode: number) => void): this; prependListener(event: "message", listener: (value: any) => void): this; + prependListener(event: "messageerror", listener: (error: Error) => void): this; prependListener(event: "online", listener: () => void): this; prependListener(event: string | symbol, listener: (...args: any[]) => void): this; prependOnceListener(event: "error", listener: (err: Error) => void): this; prependOnceListener(event: "exit", listener: (exitCode: number) => void): this; prependOnceListener(event: "message", listener: (value: any) => void): this; + prependOnceListener(event: "messageerror", listener: (error: Error) => void): this; prependOnceListener(event: "online", listener: () => void): this; prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this; removeListener(event: "error", listener: (err: Error) => void): this; removeListener(event: "exit", listener: (exitCode: number) => void): this; removeListener(event: "message", listener: (value: any) => void): this; + removeListener(event: "messageerror", listener: (error: Error) => void): this; removeListener(event: "online", listener: () => void): this; removeListener(event: string | symbol, listener: (...args: any[]) => void): this; off(event: "error", listener: (err: Error) => void): this; off(event: "exit", listener: (exitCode: number) => void): this; off(event: "message", listener: (value: any) => void): this; + off(event: "messageerror", listener: (error: Error) => void): this; off(event: "online", listener: () => void): this; off(event: string | symbol, listener: (...args: any[]) => void): this; } + + /** + * Mark an object as not transferable. + * If `object` occurs in the transfer list of a `port.postMessage()` call, it will be ignored. + * + * In particular, this makes sense for objects that can be cloned, rather than transferred, + * and which are used by other objects on the sending side. For example, Node.js marks + * the `ArrayBuffer`s it uses for its Buffer pool with this. + * + * This operation cannot be undone. + */ + function markAsUntransferable(object: object): void; + + /** + * Transfer a `MessagePort` to a different `vm` Context. The original `port` + * object will be rendered unusable, and the returned `MessagePort` instance will + * take its place. + * + * The returned `MessagePort` will be an object in the target context, and will + * inherit from its global `Object` class. Objects passed to the + * `port.onmessage()` listener will also be created in the target context + * and inherit from its global `Object` class. + * + * However, the created `MessagePort` will no longer inherit from + * `EventEmitter`, and only `port.onmessage()` can be used to receive + * events using it. + */ + function moveMessagePortToContext(port: MessagePort, context: Context): MessagePort; + + /** + * Receive a single message from a given `MessagePort`. If no message is available, + * `undefined` is returned, otherwise an object with a single `message` property + * that contains the message payload, corresponding to the oldest message in the + * `MessagePort`’s queue. + */ + function receiveMessageOnPort(port: MessagePort): { message: any } | undefined; } diff --git a/node_modules/@types/node/zlib.d.ts b/node_modules/@types/node/zlib.d.ts index a03e900..754f5ed 100644 --- a/node_modules/@types/node/zlib.d.ts +++ b/node_modules/@types/node/zlib.d.ts @@ -19,6 +19,8 @@ declare module "zlib" { memLevel?: number; // compression only strategy?: number; // compression only dictionary?: NodeJS.ArrayBufferView | ArrayBuffer; // deflate/inflate only, empty dictionary by default + info?: boolean; + maxOutputLength?: number; } interface BrotliOptions { @@ -40,6 +42,7 @@ declare module "zlib" { */ [key: number]: boolean | number; }; + maxOutputLength?: number; } interface Zlib { @@ -48,7 +51,8 @@ declare module "zlib" { readonly bytesWritten: number; shell?: boolean | string; close(callback?: () => void): void; - flush(kind?: number | (() => void), callback?: () => void): void; + flush(kind?: number, callback?: () => void): void; + flush(callback?: () => void): void; } interface ZlibParams { @@ -85,30 +89,74 @@ declare module "zlib" { function brotliCompress(buf: InputType, options: BrotliOptions, callback: CompressCallback): void; function brotliCompress(buf: InputType, callback: CompressCallback): void; + namespace brotliCompress { + function __promisify__(buffer: InputType, options?: BrotliOptions): Promise; + } + function brotliCompressSync(buf: InputType, options?: BrotliOptions): Buffer; + function brotliDecompress(buf: InputType, options: BrotliOptions, callback: CompressCallback): void; function brotliDecompress(buf: InputType, callback: CompressCallback): void; + namespace brotliDecompress { + function __promisify__(buffer: InputType, options?: BrotliOptions): Promise; + } + function brotliDecompressSync(buf: InputType, options?: BrotliOptions): Buffer; + function deflate(buf: InputType, callback: CompressCallback): void; function deflate(buf: InputType, options: ZlibOptions, callback: CompressCallback): void; + namespace deflate { + function __promisify__(buffer: InputType, options?: ZlibOptions): Promise; + } + function deflateSync(buf: InputType, options?: ZlibOptions): Buffer; + function deflateRaw(buf: InputType, callback: CompressCallback): void; function deflateRaw(buf: InputType, options: ZlibOptions, callback: CompressCallback): void; + namespace deflateRaw { + function __promisify__(buffer: InputType, options?: ZlibOptions): Promise; + } + function deflateRawSync(buf: InputType, options?: ZlibOptions): Buffer; + function gzip(buf: InputType, callback: CompressCallback): void; function gzip(buf: InputType, options: ZlibOptions, callback: CompressCallback): void; + namespace gzip { + function __promisify__(buffer: InputType, options?: ZlibOptions): Promise; + } + function gzipSync(buf: InputType, options?: ZlibOptions): Buffer; + function gunzip(buf: InputType, callback: CompressCallback): void; function gunzip(buf: InputType, options: ZlibOptions, callback: CompressCallback): void; + namespace gunzip { + function __promisify__(buffer: InputType, options?: ZlibOptions): Promise; + } + function gunzipSync(buf: InputType, options?: ZlibOptions): Buffer; + function inflate(buf: InputType, callback: CompressCallback): void; function inflate(buf: InputType, options: ZlibOptions, callback: CompressCallback): void; + namespace inflate { + function __promisify__(buffer: InputType, options?: ZlibOptions): Promise; + } + function inflateSync(buf: InputType, options?: ZlibOptions): Buffer; + function inflateRaw(buf: InputType, callback: CompressCallback): void; function inflateRaw(buf: InputType, options: ZlibOptions, callback: CompressCallback): void; + namespace inflateRaw { + function __promisify__(buffer: InputType, options?: ZlibOptions): Promise; + } + function inflateRawSync(buf: InputType, options?: ZlibOptions): Buffer; + function unzip(buf: InputType, callback: CompressCallback): void; function unzip(buf: InputType, options: ZlibOptions, callback: CompressCallback): void; + namespace unzip { + function __promisify__(buffer: InputType, options?: ZlibOptions): Promise; + } + function unzipSync(buf: InputType, options?: ZlibOptions): Buffer; namespace constants { @@ -188,165 +236,126 @@ declare module "zlib" { const INFLATERAW: number; const UNZIP: number; - const Z_BEST_COMPRESSION: number; - const Z_BEST_SPEED: number; - const Z_BLOCK: number; - const Z_BUF_ERROR: number; - const Z_DATA_ERROR: number; - - const Z_DEFAULT_CHUNK: number; - const Z_DEFAULT_COMPRESSION: number; - const Z_DEFAULT_LEVEL: number; - const Z_DEFAULT_MEMLEVEL: number; - const Z_DEFAULT_STRATEGY: number; - const Z_DEFAULT_WINDOWBITS: number; - - const Z_ERRNO: number; - const Z_FILTERED: number; - const Z_FINISH: number; - const Z_FIXED: number; - const Z_FULL_FLUSH: number; - const Z_HUFFMAN_ONLY: number; - const Z_MAX_CHUNK: number; - const Z_MAX_LEVEL: number; - const Z_MAX_MEMLEVEL: number; - const Z_MAX_WINDOWBITS: number; - const Z_MEM_ERROR: number; - const Z_MIN_CHUNK: number; - const Z_MIN_LEVEL: number; - const Z_MIN_MEMLEVEL: number; - const Z_MIN_WINDOWBITS: number; - const Z_NEED_DICT: number; - const Z_NO_COMPRESSION: number; + // Allowed flush values. const Z_NO_FLUSH: number; - const Z_OK: number; const Z_PARTIAL_FLUSH: number; - const Z_RLE: number; - const Z_STREAM_END: number; - const Z_STREAM_ERROR: number; const Z_SYNC_FLUSH: number; + const Z_FULL_FLUSH: number; + const Z_FINISH: number; + const Z_BLOCK: number; + const Z_TREES: number; + + // Return codes for the compression/decompression functions. + // Negative values are errors, positive values are used for special but normal events. + const Z_OK: number; + const Z_STREAM_END: number; + const Z_NEED_DICT: number; + const Z_ERRNO: number; + const Z_STREAM_ERROR: number; + const Z_DATA_ERROR: number; + const Z_MEM_ERROR: number; + const Z_BUF_ERROR: number; const Z_VERSION_ERROR: number; + + // Compression levels. + const Z_NO_COMPRESSION: number; + const Z_BEST_SPEED: number; + const Z_BEST_COMPRESSION: number; + const Z_DEFAULT_COMPRESSION: number; + + // Compression strategy. + const Z_FILTERED: number; + const Z_HUFFMAN_ONLY: number; + const Z_RLE: number; + const Z_FIXED: number; + const Z_DEFAULT_STRATEGY: number; + + const Z_DEFAULT_WINDOWBITS: number; + const Z_MIN_WINDOWBITS: number; + const Z_MAX_WINDOWBITS: number; + + const Z_MIN_CHUNK: number; + const Z_MAX_CHUNK: number; + const Z_DEFAULT_CHUNK: number; + + const Z_MIN_MEMLEVEL: number; + const Z_MAX_MEMLEVEL: number; + const Z_DEFAULT_MEMLEVEL: number; + + const Z_MIN_LEVEL: number; + const Z_MAX_LEVEL: number; + const Z_DEFAULT_LEVEL: number; + const ZLIB_VERNUM: number; } - /** - * @deprecated - */ + // Allowed flush values. + /** @deprecated Use `constants.Z_NO_FLUSH` */ const Z_NO_FLUSH: number; - /** - * @deprecated - */ + /** @deprecated Use `constants.Z_PARTIAL_FLUSH` */ const Z_PARTIAL_FLUSH: number; - /** - * @deprecated - */ + /** @deprecated Use `constants.Z_SYNC_FLUSH` */ const Z_SYNC_FLUSH: number; - /** - * @deprecated - */ + /** @deprecated Use `constants.Z_FULL_FLUSH` */ const Z_FULL_FLUSH: number; - /** - * @deprecated - */ + /** @deprecated Use `constants.Z_FINISH` */ const Z_FINISH: number; - /** - * @deprecated - */ + /** @deprecated Use `constants.Z_BLOCK` */ const Z_BLOCK: number; - /** - * @deprecated - */ + /** @deprecated Use `constants.Z_TREES` */ const Z_TREES: number; - /** - * @deprecated - */ + + // Return codes for the compression/decompression functions. + // Negative values are errors, positive values are used for special but normal events. + /** @deprecated Use `constants.Z_OK` */ const Z_OK: number; - /** - * @deprecated - */ + /** @deprecated Use `constants.Z_STREAM_END` */ const Z_STREAM_END: number; - /** - * @deprecated - */ + /** @deprecated Use `constants.Z_NEED_DICT` */ const Z_NEED_DICT: number; - /** - * @deprecated - */ + /** @deprecated Use `constants.Z_ERRNO` */ const Z_ERRNO: number; - /** - * @deprecated - */ + /** @deprecated Use `constants.Z_STREAM_ERROR` */ const Z_STREAM_ERROR: number; - /** - * @deprecated - */ + /** @deprecated Use `constants.Z_DATA_ERROR` */ const Z_DATA_ERROR: number; - /** - * @deprecated - */ + /** @deprecated Use `constants.Z_MEM_ERROR` */ const Z_MEM_ERROR: number; - /** - * @deprecated - */ + /** @deprecated Use `constants.Z_BUF_ERROR` */ const Z_BUF_ERROR: number; - /** - * @deprecated - */ + /** @deprecated Use `constants.Z_VERSION_ERROR` */ const Z_VERSION_ERROR: number; - /** - * @deprecated - */ + + // Compression levels. + /** @deprecated Use `constants.Z_NO_COMPRESSION` */ const Z_NO_COMPRESSION: number; - /** - * @deprecated - */ + /** @deprecated Use `constants.Z_BEST_SPEED` */ const Z_BEST_SPEED: number; - /** - * @deprecated - */ + /** @deprecated Use `constants.Z_BEST_COMPRESSION` */ const Z_BEST_COMPRESSION: number; - /** - * @deprecated - */ + /** @deprecated Use `constants.Z_DEFAULT_COMPRESSION` */ const Z_DEFAULT_COMPRESSION: number; - /** - * @deprecated - */ + + // Compression strategy. + /** @deprecated Use `constants.Z_FILTERED` */ const Z_FILTERED: number; - /** - * @deprecated - */ + /** @deprecated Use `constants.Z_HUFFMAN_ONLY` */ const Z_HUFFMAN_ONLY: number; - /** - * @deprecated - */ + /** @deprecated Use `constants.Z_RLE` */ const Z_RLE: number; - /** - * @deprecated - */ + /** @deprecated Use `constants.Z_FIXED` */ const Z_FIXED: number; - /** - * @deprecated - */ + /** @deprecated Use `constants.Z_DEFAULT_STRATEGY` */ const Z_DEFAULT_STRATEGY: number; - /** - * @deprecated - */ + + /** @deprecated */ const Z_BINARY: number; - /** - * @deprecated - */ + /** @deprecated */ const Z_TEXT: number; - /** - * @deprecated - */ + /** @deprecated */ const Z_ASCII: number; - /** - * @deprecated - */ + /** @deprecated */ const Z_UNKNOWN: number; - /** - * @deprecated - */ + /** @deprecated */ const Z_DEFLATED: number; } diff --git a/node_modules/node-fetch/CHANGELOG.md b/node_modules/node-fetch/CHANGELOG.md index 188fcd3..543d3d9 100644 --- a/node_modules/node-fetch/CHANGELOG.md +++ b/node_modules/node-fetch/CHANGELOG.md @@ -5,6 +5,12 @@ Changelog # 2.x release +## v2.6.1 + +**This is an important security release. It is strongly recommended to update as soon as possible.** + +- Fix: honor the `size` option after following a redirect. + ## v2.6.0 - Enhance: `options.agent`, it now accepts a function that returns custom http(s).Agent instance based on current URL, see readme for more information. diff --git a/node_modules/node-fetch/README.md b/node_modules/node-fetch/README.md index cb19901..2dde742 100644 --- a/node_modules/node-fetch/README.md +++ b/node_modules/node-fetch/README.md @@ -5,11 +5,14 @@ node-fetch [![build status][travis-image]][travis-url] [![coverage status][codecov-image]][codecov-url] [![install size][install-size-image]][install-size-url] +[![Discord][discord-image]][discord-url] A light-weight module that brings `window.fetch` to Node.js (We are looking for [v2 maintainers and collaborators](https://github.com/bitinn/node-fetch/issues/567)) +[![Backers][opencollective-image]][opencollective-url] + - [Motivation](#motivation) @@ -48,7 +51,7 @@ A light-weight module that brings `window.fetch` to Node.js ## Motivation -Instead of implementing `XMLHttpRequest` in Node.js to run browser-specific [Fetch polyfill](https://github.com/github/fetch), why not go from native `http` to `fetch` API directly? Hence `node-fetch`, minimal code for a `window.fetch` compatible API on Node.js runtime. +Instead of implementing `XMLHttpRequest` in Node.js to run browser-specific [Fetch polyfill](https://github.com/github/fetch), why not go from native `http` to `fetch` API directly? Hence, `node-fetch`, minimal code for a `window.fetch` compatible API on Node.js runtime. See Matt Andrews' [isomorphic-fetch](https://github.com/matthew-andrews/isomorphic-fetch) or Leonardo Quixada's [cross-fetch](https://github.com/lquixada/cross-fetch) for isomorphic usage (exports `node-fetch` for server-side, `whatwg-fetch` for client-side). @@ -56,9 +59,9 @@ See Matt Andrews' [isomorphic-fetch](https://github.com/matthew-andrews/isomorph - Stay consistent with `window.fetch` API. - Make conscious trade-off when following [WHATWG fetch spec][whatwg-fetch] and [stream spec](https://streams.spec.whatwg.org/) implementation details, document known differences. -- Use native promise, but allow substituting it with [insert your favorite promise library]. -- Use native Node streams for body, on both request and response. -- Decode content encoding (gzip/deflate) properly, and convert string output (such as `res.text()` and `res.json()`) to UTF-8 automatically. +- Use native promise but allow substituting it with [insert your favorite promise library]. +- Use native Node streams for body on both request and response. +- Decode content encoding (gzip/deflate) properly and convert string output (such as `res.text()` and `res.json()`) to UTF-8 automatically. - Useful extensions such as timeout, redirect limit, response size limit, [explicit errors](ERROR-HANDLING.md) for troubleshooting. ## Difference from client-side fetch @@ -72,16 +75,16 @@ See Matt Andrews' [isomorphic-fetch](https://github.com/matthew-andrews/isomorph Current stable release (`2.x`) ```sh -$ npm install node-fetch --save +$ npm install node-fetch ``` ## Loading and configuring the module -We suggest you load the module via `require`, pending the stabalizing of es modules in node: +We suggest you load the module via `require` until the stabilization of ES modules in node: ```js const fetch = require('node-fetch'); ``` -If you are using a Promise library other than native, set it through fetch.Promise: +If you are using a Promise library other than native, set it through `fetch.Promise`: ```js const Bluebird = require('bluebird'); @@ -90,7 +93,7 @@ fetch.Promise = Bluebird; ## Common Usage -NOTE: The documentation below is up-to-date with `2.x` releases, [see `1.x` readme](https://github.com/bitinn/node-fetch/blob/1.x/README.md), [changelog](https://github.com/bitinn/node-fetch/blob/1.x/CHANGELOG.md) and [2.x upgrade guide](UPGRADE-GUIDE.md) for the differences. +NOTE: The documentation below is up-to-date with `2.x` releases; see the [`1.x` readme](https://github.com/bitinn/node-fetch/blob/1.x/README.md), [changelog](https://github.com/bitinn/node-fetch/blob/1.x/CHANGELOG.md) and [2.x upgrade guide](UPGRADE-GUIDE.md) for the differences. #### Plain text or HTML ```js @@ -146,9 +149,9 @@ fetch('https://httpbin.org/post', { method: 'POST', body: params }) ``` #### Handling exceptions -NOTE: 3xx-5xx responses are *NOT* exceptions, and should be handled in `then()`, see the next section. +NOTE: 3xx-5xx responses are *NOT* exceptions and should be handled in `then()`; see the next section for more information. -Adding a catch to the fetch promise chain will catch *all* exceptions, such as errors originating from node core libraries, like network errors, and operational errors which are instances of FetchError. See the [error handling document](ERROR-HANDLING.md) for more details. +Adding a catch to the fetch promise chain will catch *all* exceptions, such as errors originating from node core libraries, network errors and operational errors, which are instances of FetchError. See the [error handling document](ERROR-HANDLING.md) for more details. ```js fetch('https://domain.invalid/') @@ -186,7 +189,7 @@ fetch('https://assets-cdn.github.com/images/modules/logos_page/Octocat.png') ``` #### Buffer -If you prefer to cache binary data in full, use buffer(). (NOTE: buffer() is a `node-fetch` only API) +If you prefer to cache binary data in full, use buffer(). (NOTE: `buffer()` is a `node-fetch`-only API) ```js const fileType = require('file-type'); @@ -211,7 +214,7 @@ fetch('https://github.com/') #### Extract Set-Cookie Header -Unlike browsers, you can access raw `Set-Cookie` headers manually using `Headers.raw()`, this is a `node-fetch` only API. +Unlike browsers, you can access raw `Set-Cookie` headers manually using `Headers.raw()`. This is a `node-fetch` only API. ```js fetch(url).then(res => { @@ -263,11 +266,11 @@ fetch('https://httpbin.org/post', options) #### Request cancellation with AbortSignal -> NOTE: You may only cancel streamed requests on Node >= v8.0.0 +> NOTE: You may cancel streamed requests only on Node >= v8.0.0 You may cancel requests with `AbortController`. A suggested implementation is [`abort-controller`](https://www.npmjs.com/package/abort-controller). -An example of timing out a request after 150ms could be achieved as follows: +An example of timing out a request after 150ms could be achieved as the following: ```js import AbortController from 'abort-controller'; @@ -308,7 +311,7 @@ See [test cases](https://github.com/bitinn/node-fetch/blob/master/test/test.js) Perform an HTTP(S) fetch. -`url` should be an absolute url, such as `https://example.com/`. A path-relative URL (`/file/under/root`) or protocol-relative URL (`//can-be-http-or-https.com/`) will result in a rejected promise. +`url` should be an absolute url, such as `https://example.com/`. A path-relative URL (`/file/under/root`) or protocol-relative URL (`//can-be-http-or-https.com/`) will result in a rejected `Promise`. ### Options @@ -350,7 +353,7 @@ Note: when `body` is a `Stream`, `Content-Length` is not set automatically. ##### Custom Agent -The `agent` option allows you to specify networking related options that's out of the scope of Fetch. Including and not limit to: +The `agent` option allows you to specify networking related options which are out of the scope of Fetch, including and not limited to the following: - Support self-signed certificate - Use only IPv4 or IPv6 @@ -358,7 +361,7 @@ The `agent` option allows you to specify networking related options that's out o See [`http.Agent`](https://nodejs.org/api/http.html#http_new_agent_options) for more information. -In addition, `agent` option accepts a function that returns http(s).Agent instance given current [URL](https://nodejs.org/api/url.html), this is useful during a redirection chain across HTTP and HTTPS protocol. +In addition, the `agent` option accepts a function that returns `http`(s)`.Agent` instance given current [URL](https://nodejs.org/api/url.html), this is useful during a redirection chain across HTTP and HTTPS protocol. ```js const httpAgent = new http.Agent({ @@ -432,7 +435,7 @@ The following properties are not implemented in node-fetch at this moment: *(spec-compliant)* -- `body` A string or [Readable stream][node-readable] +- `body` A `String` or [`Readable` stream][node-readable] - `options` A [`ResponseInit`][response-init] options dictionary Constructs a new `Response` object. The constructor is identical to that in the [browser](https://developer.mozilla.org/en-US/docs/Web/API/Response/Response). @@ -462,7 +465,7 @@ This class allows manipulating and iterating over a set of HTTP headers. All met - `init` Optional argument to pre-fill the `Headers` object -Construct a new `Headers` object. `init` can be either `null`, a `Headers` object, an key-value map object, or any iterable object. +Construct a new `Headers` object. `init` can be either `null`, a `Headers` object, an key-value map object or any iterable object. ```js // Example adapted from https://fetch.spec.whatwg.org/#example-headers-class @@ -503,7 +506,7 @@ The following methods are not yet implemented in node-fetch at this moment: * Node.js [`Readable` stream][node-readable] -The data encapsulated in the `Body` object. Note that while the [Fetch Standard][whatwg-fetch] requires the property to always be a WHATWG `ReadableStream`, in node-fetch it is a Node.js [`Readable` stream][node-readable]. +Data are encapsulated in the `Body` object. Note that while the [Fetch Standard][whatwg-fetch] requires the property to always be a WHATWG `ReadableStream`, in node-fetch it is a Node.js [`Readable` stream][node-readable]. #### body.bodyUsed @@ -511,7 +514,7 @@ The data encapsulated in the `Body` object. Note that while the [Fetch Standard] * `Boolean` -A boolean property for if this body has been consumed. Per spec, a consumed body cannot be used again. +A boolean property for if this body has been consumed. Per the specs, a consumed body cannot be used again. #### body.arrayBuffer() #### body.blob() @@ -538,9 +541,9 @@ Consume the body and return a promise that will resolve to a Buffer. * Returns: Promise<String> -Identical to `body.text()`, except instead of always converting to UTF-8, encoding sniffing will be performed and text converted to UTF-8, if possible. +Identical to `body.text()`, except instead of always converting to UTF-8, encoding sniffing will be performed and text converted to UTF-8 if possible. -(This API requires an optional dependency on npm package [encoding](https://www.npmjs.com/package/encoding), which you need to install manually. `webpack` users may see [a warning message](https://github.com/bitinn/node-fetch/issues/412#issuecomment-379007792) due to this optional dependency.) +(This API requires an optional dependency of the npm package [encoding](https://www.npmjs.com/package/encoding), which you need to install manually. `webpack` users may see [a warning message](https://github.com/bitinn/node-fetch/issues/412#issuecomment-379007792) due to this optional dependency.) ### Class: FetchError @@ -574,6 +577,10 @@ MIT [codecov-url]: https://codecov.io/gh/bitinn/node-fetch [install-size-image]: https://flat.badgen.net/packagephobia/install/node-fetch [install-size-url]: https://packagephobia.now.sh/result?p=node-fetch +[discord-image]: https://img.shields.io/discord/619915844268326952?color=%237289DA&label=Discord&style=flat-square +[discord-url]: https://discord.gg/Zxbndcm +[opencollective-image]: https://opencollective.com/node-fetch/backers.svg +[opencollective-url]: https://opencollective.com/node-fetch [whatwg-fetch]: https://fetch.spec.whatwg.org/ [response-init]: https://fetch.spec.whatwg.org/#responseinit [node-readable]: https://nodejs.org/api/stream.html#stream_readable_streams diff --git a/node_modules/node-fetch/browser.js b/node_modules/node-fetch/browser.js index 0ad5de0..83c54c5 100644 --- a/node_modules/node-fetch/browser.js +++ b/node_modules/node-fetch/browser.js @@ -16,7 +16,9 @@ var global = getGlobal(); module.exports = exports = global.fetch; // Needed for TypeScript and Webpack. -exports.default = global.fetch.bind(global); +if (global.fetch) { + exports.default = global.fetch.bind(global); +} exports.Headers = global.Headers; exports.Request = global.Request; diff --git a/node_modules/node-fetch/lib/index.es.js b/node_modules/node-fetch/lib/index.es.js index 37d022c..61906c9 100644 --- a/node_modules/node-fetch/lib/index.es.js +++ b/node_modules/node-fetch/lib/index.es.js @@ -461,6 +461,12 @@ function convertBody(buffer, headers) { // html4 if (!res && str) { res = /' - } - - throw error - } -} diff --git a/node_modules/universal-user-agent/package.json b/node_modules/universal-user-agent/package.json index 83547e4..9ce9bfa 100644 --- a/node_modules/universal-user-agent/package.json +++ b/node_modules/universal-user-agent/package.json @@ -1,82 +1,69 @@ { - "_from": "universal-user-agent@^2.0.3", - "_id": "universal-user-agent@2.1.0", + "_args": [ + [ + "universal-user-agent@4.0.1", + "/Users/marocchino/Documents/sticky-pull-request-comment" + ] + ], + "_from": "universal-user-agent@4.0.1", + "_id": "universal-user-agent@4.0.1", "_inBundle": false, - "_integrity": "sha512-8itiX7G05Tu3mGDTdNY2fB4KJ8MgZLS54RdG6PkkfwMAavrXu1mV/lls/GABx9O3Rw4PnTtasxrvbMQoBYY92Q==", + "_integrity": "sha512-LnST3ebHwVL2aNe4mejI9IQh2HfZ1RLo8Io2HugSif8ekzD1TlWpHpColOB/eh8JHMLkGH3Akqf040I+4ylNxg==", "_location": "/universal-user-agent", "_phantomChildren": {}, "_requested": { - "type": "range", + "type": "version", "registry": true, - "raw": "universal-user-agent@^2.0.3", + "raw": "universal-user-agent@4.0.1", "name": "universal-user-agent", "escapedName": "universal-user-agent", - "rawSpec": "^2.0.3", + "rawSpec": "4.0.1", "saveSpec": null, - "fetchSpec": "^2.0.3" + "fetchSpec": "4.0.1" }, "_requiredBy": [ - "/@octokit/graphql" + "/@octokit/graphql", + "/@octokit/rest" ], - "_resolved": "https://registry.npmjs.org/universal-user-agent/-/universal-user-agent-2.1.0.tgz", - "_shasum": "5abfbcc036a1ba490cb941f8fd68c46d3669e8e4", - "_spec": "universal-user-agent@^2.0.3", - "_where": "/Users/shim.taewon/Documents/sticky-pull-request-comment/node_modules/@octokit/graphql", - "author": { - "name": "Gregor Martynus", - "url": "https://github.com/gr2m" - }, - "browser": "browser.js", + "_resolved": "https://registry.npmjs.org/universal-user-agent/-/universal-user-agent-4.0.1.tgz", + "_spec": "4.0.1", + "_where": "/Users/marocchino/Documents/sticky-pull-request-comment", "bugs": { "url": "https://github.com/gr2m/universal-user-agent/issues" }, - "bundleDependencies": false, "dependencies": { - "os-name": "^3.0.0" + "os-name": "^3.1.0" }, - "deprecated": false, "description": "Get a user agent string in both browser and node", "devDependencies": { - "chai": "^4.1.2", - "coveralls": "^3.0.2", - "cypress": "^3.1.0", - "mocha": "^6.0.0", - "nyc": "^14.0.0", - "proxyquire": "^2.1.0", - "semantic-release": "^15.9.15", - "sinon": "^7.2.4", - "sinon-chai": "^3.2.0", - "standard": "^12.0.1", - "test": "^0.6.0", - "travis-deploy-once": "^5.0.7" + "@gr2m/pika-plugin-build-web": "^0.6.0-issue-84.1", + "@pika/pack": "^0.5.0", + "@pika/plugin-build-node": "^0.9.1", + "@pika/plugin-ts-standard-pkg": "^0.9.1", + "@types/jest": "^25.1.0", + "jest": "^24.9.0", + "prettier": "^1.18.2", + "semantic-release": "^17.0.0", + "ts-jest": "^25.1.0", + "typescript": "^3.6.2" }, + "files": [ + "dist-*/", + "bin/" + ], "homepage": "https://github.com/gr2m/universal-user-agent#readme", "keywords": [], "license": "ISC", - "main": "index.js", + "main": "dist-node/index.js", + "module": "dist-web/index.js", "name": "universal-user-agent", + "pika": true, "repository": { "type": "git", "url": "git+https://github.com/gr2m/universal-user-agent.git" }, - "scripts": { - "coverage": "nyc report --reporter=html && open coverage/index.html", - "coverage:upload": "nyc report --reporter=text-lcov | coveralls", - "pretest": "standard", - "semantic-release": "semantic-release", - "test": "nyc mocha \"test/*-test.js\"", - "test:browser": "cypress run --browser chrome", - "travis-deploy-once": "travis-deploy-once" - }, - "standard": { - "globals": [ - "describe", - "it", - "beforeEach", - "afterEach", - "expect" - ] - }, - "types": "index.d.ts", - "version": "2.1.0" + "sideEffects": false, + "source": "dist-src/index.js", + "types": "dist-types/index.d.ts", + "version": "4.0.1" } diff --git a/node_modules/universal-user-agent/test/smoke-test.js b/node_modules/universal-user-agent/test/smoke-test.js deleted file mode 100644 index d71b2d5..0000000 --- a/node_modules/universal-user-agent/test/smoke-test.js +++ /dev/null @@ -1,57 +0,0 @@ -// make tests run in both Node & Express -if (!global.cy) { - const chai = require('chai') - const sinon = require('sinon') - const sinonChai = require('sinon-chai') - chai.use(sinonChai) - global.expect = chai.expect - - let sandbox - beforeEach(() => { - sandbox = sinon.createSandbox() - global.cy = { - stub: function () { - return sandbox.stub.apply(sandbox, arguments) - }, - log () { - console.log.apply(console, arguments) - } - } - }) - - afterEach(() => { - sandbox.restore() - }) -} - -const getUserAgent = require('..') - -describe('smoke', () => { - it('works', () => { - expect(getUserAgent()).to.be.a('string') - expect(getUserAgent().length).to.be.above(10) - }) - - if (!process.browser) { // test on node only - const proxyquire = require('proxyquire').noCallThru() - it('works around wmic error on Windows (#5)', () => { - const getUserAgent = proxyquire('..', { - 'os-name': () => { - throw new Error('Command failed: wmic os get Caption') - } - }) - - expect(getUserAgent()).to.equal('Windows ') - }) - - it('does not swallow unexpected errors', () => { - const getUserAgent = proxyquire('..', { - 'os-name': () => { - throw new Error('oops') - } - }) - - expect(getUserAgent).to.throw('oops') - }) - } -}) diff --git a/node_modules/windows-release/index.js b/node_modules/windows-release/index.js index cb9ea9f..9ea83dc 100644 --- a/node_modules/windows-release/index.js +++ b/node_modules/windows-release/index.js @@ -26,13 +26,21 @@ const windowsRelease = release => { const ver = (version || [])[0]; - // Server 2008, 2012 and 2016 versions are ambiguous with desktop versions and must be detected at runtime. + // Server 2008, 2012, 2016, and 2019 versions are ambiguous with desktop versions and must be detected at runtime. // If `release` is omitted or we're on a Windows system, and the version number is an ambiguous version // then use `wmic` to get the OS caption: https://msdn.microsoft.com/en-us/library/aa394531(v=vs.85).aspx - // If the resulting caption contains the year 2008, 2012 or 2016, it is a server version, so return a server OS name. + // If `wmic` is obsoloete (later versions of Windows 10), use PowerShell instead. + // If the resulting caption contains the year 2008, 2012, 2016 or 2019, it is a server version, so return a server OS name. if ((!release || release === os.release()) && ['6.1', '6.2', '6.3', '10.0'].includes(ver)) { - const stdout = execa.sync('wmic', ['os', 'get', 'Caption']).stdout || ''; - const year = (stdout.match(/2008|2012|2016/) || [])[0]; + let stdout; + try { + stdout = execa.sync('powershell', ['(Get-CimInstance -ClassName Win32_OperatingSystem).caption']).stdout || ''; + } catch (_) { + stdout = execa.sync('wmic', ['os', 'get', 'Caption']).stdout || ''; + } + + const year = (stdout.match(/2008|2012|2016|2019/) || [])[0]; + if (year) { return `Server ${year}`; } diff --git a/node_modules/windows-release/license b/node_modules/windows-release/license index e7af2f7..fa7ceba 100644 --- a/node_modules/windows-release/license +++ b/node_modules/windows-release/license @@ -1,6 +1,6 @@ MIT License -Copyright (c) Sindre Sorhus (sindresorhus.com) +Copyright (c) Sindre Sorhus (https://sindresorhus.com) 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: diff --git a/node_modules/windows-release/package.json b/node_modules/windows-release/package.json index ef3e04f..32bcb9b 100644 --- a/node_modules/windows-release/package.json +++ b/node_modules/windows-release/package.json @@ -1,40 +1,43 @@ { - "_from": "windows-release@^3.1.0", - "_id": "windows-release@3.2.0", + "_args": [ + [ + "windows-release@3.3.0", + "/Users/marocchino/Documents/sticky-pull-request-comment" + ] + ], + "_from": "windows-release@3.3.0", + "_id": "windows-release@3.3.0", "_inBundle": false, - "_integrity": "sha512-QTlz2hKLrdqukrsapKsINzqMgOUpQW268eJ0OaOpJN32h272waxR9fkB9VoWRtK7uKHG5EHJcTXQBD8XZVJkFA==", + "_integrity": "sha512-2HetyTg1Y+R+rUgrKeUEhAG/ZuOmTrI1NBb3ZyAGQMYmOJjBBPe4MTodghRkmLJZHwkuPi02anbeGP+Zf401LQ==", "_location": "/windows-release", "_phantomChildren": {}, "_requested": { - "type": "range", + "type": "version", "registry": true, - "raw": "windows-release@^3.1.0", + "raw": "windows-release@3.3.0", "name": "windows-release", "escapedName": "windows-release", - "rawSpec": "^3.1.0", + "rawSpec": "3.3.0", "saveSpec": null, - "fetchSpec": "^3.1.0" + "fetchSpec": "3.3.0" }, "_requiredBy": [ "/os-name" ], - "_resolved": "https://registry.npmjs.org/windows-release/-/windows-release-3.2.0.tgz", - "_shasum": "8122dad5afc303d833422380680a79cdfa91785f", - "_spec": "windows-release@^3.1.0", - "_where": "/Users/shim.taewon/Documents/sticky-pull-request-comment/node_modules/os-name", + "_resolved": "https://registry.npmjs.org/windows-release/-/windows-release-3.3.0.tgz", + "_spec": "3.3.0", + "_where": "/Users/marocchino/Documents/sticky-pull-request-comment", "author": { "name": "Sindre Sorhus", "email": "sindresorhus@gmail.com", - "url": "sindresorhus.com" + "url": "https://sindresorhus.com" }, "bugs": { "url": "https://github.com/sindresorhus/windows-release/issues" }, - "bundleDependencies": false, "dependencies": { "execa": "^1.0.0" }, - "deprecated": false, "description": "Get the name of a Windows version from the release number: `5.1.2600` → `XP`", "devDependencies": { "ava": "^1.4.1", @@ -48,6 +51,7 @@ "index.js", "index.d.ts" ], + "funding": "https://github.com/sponsors/sindresorhus", "homepage": "https://github.com/sindresorhus/windows-release#readme", "keywords": [ "os", @@ -71,5 +75,5 @@ "scripts": { "test": "xo && ava && tsd" }, - "version": "3.2.0" + "version": "3.3.0" } diff --git a/node_modules/windows-release/readme.md b/node_modules/windows-release/readme.md index 66557ea..69ea9bd 100644 --- a/node_modules/windows-release/readme.md +++ b/node_modules/windows-release/readme.md @@ -2,14 +2,12 @@ > Get the name of a Windows version from the release number: `5.1.2600` → `XP` - ## Install ``` $ npm install windows-release ``` - ## Usage ```js @@ -31,10 +29,9 @@ windowsRelease('4.9.3000'); //=> 'ME' ``` - ## API -### windowsRelease([release]) +### windowsRelease(release?) #### release @@ -44,13 +41,19 @@ By default, the current OS is used, but you can supply a custom release number, Note: Most Windows Server versions cannot be detected based on the release number alone. There is runtime detection in place to work around this, but it will only be used if no argument is supplied, or the supplied argument matches `os.release()`. - ## Related - [os-name](https://github.com/sindresorhus/os-name) - Get the name of the current operating system - [macos-release](https://github.com/sindresorhus/macos-release) - Get the name and version of a macOS release from the Darwin version +--- -## License - -MIT © [Sindre Sorhus](https://sindresorhus.com) +
+ + Get professional support for this package with a Tidelift subscription + +
+ + Tidelift helps make open source sustainable for maintainers while giving companies
assurances about security, maintenance, and licensing for their dependencies. +
+