From 9a98d4e6f2cb7e2686834ce9b9c9fc6df0dc0a7c Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Tue, 8 Apr 2025 23:33:43 +0200 Subject: [PATCH 1/3] chore(deps): update dependency sinon to v20 (#793) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- package-lock.json | 49 +++++------------------------------------------ package.json | 2 +- 2 files changed, 6 insertions(+), 45 deletions(-) diff --git a/package-lock.json b/package-lock.json index cb6e8a6e..ba8c0484 100644 --- a/package-lock.json +++ b/package-lock.json @@ -23,7 +23,7 @@ "glob": "^11.0.0", "prettier": "3.5.3", "semantic-release-plugin-update-version-in-files": "^2.0.0", - "sinon": "^19.0.0", + "sinon": "^20.0.0", "sort-keys": "^5.0.0", "string-to-jsdoc-comment": "^1.0.0", "typescript": "^5.0.0", @@ -1123,13 +1123,6 @@ "node": ">=4" } }, - "node_modules/@sinonjs/text-encoding": { - "version": "0.7.3", - "resolved": "https://registry.npmjs.org/@sinonjs/text-encoding/-/text-encoding-0.7.3.tgz", - "integrity": "sha512-DE427ROAphMQzU4ENbliGYrBSYPXF+TtLg9S8vzeA+OF4ZKzoDdzfL8sxuMUGS/lgRhM6j1URSk9ghf7Xo1tyA==", - "dev": true, - "license": "(Unlicense OR Apache-2.0)" - }, "node_modules/@szmarczak/http-timer": { "version": "4.0.6", "resolved": "https://registry.npmjs.org/@szmarczak/http-timer/-/http-timer-4.0.6.tgz", @@ -2061,13 +2054,6 @@ "dev": true, "license": "MIT" }, - "node_modules/just-extend": { - "version": "6.2.0", - "resolved": "https://registry.npmjs.org/just-extend/-/just-extend-6.2.0.tgz", - "integrity": "sha512-cYofQu2Xpom82S6qD778jBDpwvvy39s1l/hrYij2u9AMdQcGRpaBu6kY4mVhuno5kJVi1DAz4aiphA2WI1/OAw==", - "dev": true, - "license": "MIT" - }, "node_modules/keyv": { "version": "4.5.4", "resolved": "https://registry.npmjs.org/keyv/-/keyv-4.5.4.tgz", @@ -2220,20 +2206,6 @@ "node": "^10 || ^12 || ^13.7 || ^14 || >=15.0.1" } }, - "node_modules/nise": { - "version": "6.1.1", - "resolved": "https://registry.npmjs.org/nise/-/nise-6.1.1.tgz", - "integrity": "sha512-aMSAzLVY7LyeM60gvBS423nBmIPP+Wy7St7hsb+8/fc1HmeoHJfLO8CKse4u3BtOZvQLJghYPI2i/1WZrEj5/g==", - "dev": true, - "license": "BSD-3-Clause", - "dependencies": { - "@sinonjs/commons": "^3.0.1", - "@sinonjs/fake-timers": "^13.0.1", - "@sinonjs/text-encoding": "^0.7.3", - "just-extend": "^6.2.0", - "path-to-regexp": "^8.1.0" - } - }, "node_modules/normalize-url": { "version": "6.1.0", "resolved": "https://registry.npmjs.org/normalize-url/-/normalize-url-6.1.0.tgz", @@ -2301,16 +2273,6 @@ "url": "https://github.com/sponsors/isaacs" } }, - "node_modules/path-to-regexp": { - "version": "8.2.0", - "resolved": "https://registry.npmjs.org/path-to-regexp/-/path-to-regexp-8.2.0.tgz", - "integrity": "sha512-TdrF7fW9Rphjq4RjrW0Kp2AW0Ahwu9sRGTkS6bvDi0SCwZlEZYmcfDbEsTz8RVk0EHIS/Vd1bv3JhG+1xZuAyQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=16" - } - }, "node_modules/pathe": { "version": "2.0.2", "resolved": "https://registry.npmjs.org/pathe/-/pathe-2.0.2.tgz", @@ -2621,17 +2583,16 @@ } }, "node_modules/sinon": { - "version": "19.0.2", - "resolved": "https://registry.npmjs.org/sinon/-/sinon-19.0.2.tgz", - "integrity": "sha512-euuToqM+PjO4UgXeLETsfQiuoyPXlqFezr6YZDFwHR3t4qaX0fZUe1MfPMznTL5f8BWrVS89KduLdMUsxFCO6g==", + "version": "20.0.0", + "resolved": "https://registry.npmjs.org/sinon/-/sinon-20.0.0.tgz", + "integrity": "sha512-+FXOAbdnj94AQIxH0w1v8gzNxkawVvNqE3jUzRLptR71Oykeu2RrQXXl/VQjKay+Qnh73fDt/oDfMo6xMeDQbQ==", "dev": true, "license": "BSD-3-Clause", "dependencies": { "@sinonjs/commons": "^3.0.1", - "@sinonjs/fake-timers": "^13.0.2", + "@sinonjs/fake-timers": "^13.0.5", "@sinonjs/samsam": "^8.0.1", "diff": "^7.0.0", - "nise": "^6.1.1", "supports-color": "^7.2.0" }, "funding": { diff --git a/package.json b/package.json index cddc5684..8dabc9fc 100644 --- a/package.json +++ b/package.json @@ -39,7 +39,7 @@ "glob": "^11.0.0", "prettier": "3.5.3", "semantic-release-plugin-update-version-in-files": "^2.0.0", - "sinon": "^19.0.0", + "sinon": "^20.0.0", "sort-keys": "^5.0.0", "string-to-jsdoc-comment": "^1.0.0", "typescript": "^5.0.0", From aa576af4f111f8511c1cc7461ced5c813fe96c21 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 9 Apr 2025 00:00:30 +0200 Subject: [PATCH 2/3] build(deps): bump vite from 6.1.0 to 6.2.5 (#795) Bumps [vite](https://github.com/vitejs/vite/tree/HEAD/packages/vite) from 6.1.0 to 6.2.5. - [Release notes](https://github.com/vitejs/vite/releases) - [Changelog](https://github.com/vitejs/vite/blob/v6.2.5/packages/vite/CHANGELOG.md) - [Commits](https://github.com/vitejs/vite/commits/v6.2.5/packages/vite) --- updated-dependencies: - dependency-name: vite dependency-version: 6.2.5 dependency-type: indirect ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- package-lock.json | 488 ++-------------------------------------------- 1 file changed, 11 insertions(+), 477 deletions(-) diff --git a/package-lock.json b/package-lock.json index ba8c0484..5179a09d 100644 --- a/package-lock.json +++ b/package-lock.json @@ -2188,9 +2188,9 @@ "license": "MIT" }, "node_modules/nanoid": { - "version": "3.3.8", - "resolved": "https://registry.npmjs.org/nanoid/-/nanoid-3.3.8.tgz", - "integrity": "sha512-WNLf5Sd8oZxOm+TzppcYk8gVOgP+l58xNy58D0nbUnOxOWRWvlcCV4kUF7ltmI6PsrLl/BgKEyS4mqsGChFN0w==", + "version": "3.3.11", + "resolved": "https://registry.npmjs.org/nanoid/-/nanoid-3.3.11.tgz", + "integrity": "sha512-N8SpfPUnUp1bK+PMYW8qSWdl9U+wwNWI4QKxOYDy9JAro3WMX7p2OeVRF9v+347pnakNevPmiHhNmZ2HbFA76w==", "dev": true, "funding": [ { @@ -2298,9 +2298,9 @@ "license": "ISC" }, "node_modules/postcss": { - "version": "8.5.1", - "resolved": "https://registry.npmjs.org/postcss/-/postcss-8.5.1.tgz", - "integrity": "sha512-6oz2beyjc5VMn/KV1pPw8fliQkhBXrVn1Z3TVyqZxU8kZpzEKhBdmCFqI6ZbmGtamQvQGuU1sgPTk8ZrXDD7jQ==", + "version": "8.5.3", + "resolved": "https://registry.npmjs.org/postcss/-/postcss-8.5.3.tgz", + "integrity": "sha512-dle9A3yYxlBSrt8Fu+IpjGT8SY8hN0mlaA6GY8t0P5PjIOZemULz/E2Bnm/2dcUOena75OTNkHI76uZBNUUq3A==", "dev": true, "funding": [ { @@ -2964,14 +2964,14 @@ } }, "node_modules/vite": { - "version": "6.1.0", - "resolved": "https://registry.npmjs.org/vite/-/vite-6.1.0.tgz", - "integrity": "sha512-RjjMipCKVoR4hVfPY6GQTgveinjNuyLw+qruksLDvA5ktI1150VmcMBKmQaEWJhg/j6Uaf6dNCNA0AfdzUb/hQ==", + "version": "6.2.5", + "resolved": "https://registry.npmjs.org/vite/-/vite-6.2.5.tgz", + "integrity": "sha512-j023J/hCAa4pRIUH6J9HemwYfjB5llR2Ps0CWeikOtdR8+pAURAk0DoJC5/mm9kd+UgdnIy7d6HE4EAvlYhPhA==", "dev": true, "license": "MIT", "dependencies": { - "esbuild": "^0.24.2", - "postcss": "^8.5.1", + "esbuild": "^0.25.0", + "postcss": "^8.5.3", "rollup": "^4.30.1" }, "bin": { @@ -3058,472 +3058,6 @@ "url": "https://opencollective.com/vitest" } }, - "node_modules/vite/node_modules/@esbuild/aix-ppc64": { - "version": "0.24.2", - "resolved": "https://registry.npmjs.org/@esbuild/aix-ppc64/-/aix-ppc64-0.24.2.tgz", - "integrity": "sha512-thpVCb/rhxE/BnMLQ7GReQLLN8q9qbHmI55F4489/ByVg2aQaQ6kbcLb6FHkocZzQhxc4gx0sCk0tJkKBFzDhA==", - "cpu": [ - "ppc64" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "aix" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/vite/node_modules/@esbuild/android-arm": { - "version": "0.24.2", - "resolved": "https://registry.npmjs.org/@esbuild/android-arm/-/android-arm-0.24.2.tgz", - "integrity": "sha512-tmwl4hJkCfNHwFB3nBa8z1Uy3ypZpxqxfTQOcHX+xRByyYgunVbZ9MzUUfb0RxaHIMnbHagwAxuTL+tnNM+1/Q==", - "cpu": [ - "arm" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "android" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/vite/node_modules/@esbuild/android-arm64": { - "version": "0.24.2", - "resolved": "https://registry.npmjs.org/@esbuild/android-arm64/-/android-arm64-0.24.2.tgz", - "integrity": "sha512-cNLgeqCqV8WxfcTIOeL4OAtSmL8JjcN6m09XIgro1Wi7cF4t/THaWEa7eL5CMoMBdjoHOTh/vwTO/o2TRXIyzg==", - "cpu": [ - "arm64" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "android" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/vite/node_modules/@esbuild/android-x64": { - "version": "0.24.2", - "resolved": "https://registry.npmjs.org/@esbuild/android-x64/-/android-x64-0.24.2.tgz", - "integrity": "sha512-B6Q0YQDqMx9D7rvIcsXfmJfvUYLoP722bgfBlO5cGvNVb5V/+Y7nhBE3mHV9OpxBf4eAS2S68KZztiPaWq4XYw==", - "cpu": [ - "x64" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "android" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/vite/node_modules/@esbuild/darwin-arm64": { - "version": "0.24.2", - "resolved": "https://registry.npmjs.org/@esbuild/darwin-arm64/-/darwin-arm64-0.24.2.tgz", - "integrity": "sha512-kj3AnYWc+CekmZnS5IPu9D+HWtUI49hbnyqk0FLEJDbzCIQt7hg7ucF1SQAilhtYpIujfaHr6O0UHlzzSPdOeA==", - "cpu": [ - "arm64" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "darwin" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/vite/node_modules/@esbuild/darwin-x64": { - "version": "0.24.2", - "resolved": "https://registry.npmjs.org/@esbuild/darwin-x64/-/darwin-x64-0.24.2.tgz", - "integrity": "sha512-WeSrmwwHaPkNR5H3yYfowhZcbriGqooyu3zI/3GGpF8AyUdsrrP0X6KumITGA9WOyiJavnGZUwPGvxvwfWPHIA==", - "cpu": [ - "x64" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "darwin" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/vite/node_modules/@esbuild/freebsd-arm64": { - "version": "0.24.2", - "resolved": "https://registry.npmjs.org/@esbuild/freebsd-arm64/-/freebsd-arm64-0.24.2.tgz", - "integrity": "sha512-UN8HXjtJ0k/Mj6a9+5u6+2eZ2ERD7Edt1Q9IZiB5UZAIdPnVKDoG7mdTVGhHJIeEml60JteamR3qhsr1r8gXvg==", - "cpu": [ - "arm64" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "freebsd" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/vite/node_modules/@esbuild/freebsd-x64": { - "version": "0.24.2", - "resolved": "https://registry.npmjs.org/@esbuild/freebsd-x64/-/freebsd-x64-0.24.2.tgz", - "integrity": "sha512-TvW7wE/89PYW+IevEJXZ5sF6gJRDY/14hyIGFXdIucxCsbRmLUcjseQu1SyTko+2idmCw94TgyaEZi9HUSOe3Q==", - "cpu": [ - "x64" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "freebsd" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/vite/node_modules/@esbuild/linux-arm": { - "version": "0.24.2", - "resolved": "https://registry.npmjs.org/@esbuild/linux-arm/-/linux-arm-0.24.2.tgz", - "integrity": "sha512-n0WRM/gWIdU29J57hJyUdIsk0WarGd6To0s+Y+LwvlC55wt+GT/OgkwoXCXvIue1i1sSNWblHEig00GBWiJgfA==", - "cpu": [ - "arm" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "linux" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/vite/node_modules/@esbuild/linux-arm64": { - "version": "0.24.2", - "resolved": "https://registry.npmjs.org/@esbuild/linux-arm64/-/linux-arm64-0.24.2.tgz", - "integrity": "sha512-7HnAD6074BW43YvvUmE/35Id9/NB7BeX5EoNkK9obndmZBUk8xmJJeU7DwmUeN7tkysslb2eSl6CTrYz6oEMQg==", - "cpu": [ - "arm64" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "linux" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/vite/node_modules/@esbuild/linux-ia32": { - "version": "0.24.2", - "resolved": "https://registry.npmjs.org/@esbuild/linux-ia32/-/linux-ia32-0.24.2.tgz", - "integrity": "sha512-sfv0tGPQhcZOgTKO3oBE9xpHuUqguHvSo4jl+wjnKwFpapx+vUDcawbwPNuBIAYdRAvIDBfZVvXprIj3HA+Ugw==", - "cpu": [ - "ia32" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "linux" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/vite/node_modules/@esbuild/linux-loong64": { - "version": "0.24.2", - "resolved": "https://registry.npmjs.org/@esbuild/linux-loong64/-/linux-loong64-0.24.2.tgz", - "integrity": "sha512-CN9AZr8kEndGooS35ntToZLTQLHEjtVB5n7dl8ZcTZMonJ7CCfStrYhrzF97eAecqVbVJ7APOEe18RPI4KLhwQ==", - "cpu": [ - "loong64" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "linux" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/vite/node_modules/@esbuild/linux-mips64el": { - "version": "0.24.2", - "resolved": "https://registry.npmjs.org/@esbuild/linux-mips64el/-/linux-mips64el-0.24.2.tgz", - "integrity": "sha512-iMkk7qr/wl3exJATwkISxI7kTcmHKE+BlymIAbHO8xanq/TjHaaVThFF6ipWzPHryoFsesNQJPE/3wFJw4+huw==", - "cpu": [ - "mips64el" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "linux" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/vite/node_modules/@esbuild/linux-ppc64": { - "version": "0.24.2", - "resolved": "https://registry.npmjs.org/@esbuild/linux-ppc64/-/linux-ppc64-0.24.2.tgz", - "integrity": "sha512-shsVrgCZ57Vr2L8mm39kO5PPIb+843FStGt7sGGoqiiWYconSxwTiuswC1VJZLCjNiMLAMh34jg4VSEQb+iEbw==", - "cpu": [ - "ppc64" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "linux" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/vite/node_modules/@esbuild/linux-riscv64": { - "version": "0.24.2", - "resolved": "https://registry.npmjs.org/@esbuild/linux-riscv64/-/linux-riscv64-0.24.2.tgz", - "integrity": "sha512-4eSFWnU9Hhd68fW16GD0TINewo1L6dRrB+oLNNbYyMUAeOD2yCK5KXGK1GH4qD/kT+bTEXjsyTCiJGHPZ3eM9Q==", - "cpu": [ - "riscv64" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "linux" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/vite/node_modules/@esbuild/linux-s390x": { - "version": "0.24.2", - "resolved": "https://registry.npmjs.org/@esbuild/linux-s390x/-/linux-s390x-0.24.2.tgz", - "integrity": "sha512-S0Bh0A53b0YHL2XEXC20bHLuGMOhFDO6GN4b3YjRLK//Ep3ql3erpNcPlEFed93hsQAjAQDNsvcK+hV90FubSw==", - "cpu": [ - "s390x" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "linux" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/vite/node_modules/@esbuild/linux-x64": { - "version": "0.24.2", - "resolved": "https://registry.npmjs.org/@esbuild/linux-x64/-/linux-x64-0.24.2.tgz", - "integrity": "sha512-8Qi4nQcCTbLnK9WoMjdC9NiTG6/E38RNICU6sUNqK0QFxCYgoARqVqxdFmWkdonVsvGqWhmm7MO0jyTqLqwj0Q==", - "cpu": [ - "x64" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "linux" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/vite/node_modules/@esbuild/netbsd-arm64": { - "version": "0.24.2", - "resolved": "https://registry.npmjs.org/@esbuild/netbsd-arm64/-/netbsd-arm64-0.24.2.tgz", - "integrity": "sha512-wuLK/VztRRpMt9zyHSazyCVdCXlpHkKm34WUyinD2lzK07FAHTq0KQvZZlXikNWkDGoT6x3TD51jKQ7gMVpopw==", - "cpu": [ - "arm64" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "netbsd" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/vite/node_modules/@esbuild/netbsd-x64": { - "version": "0.24.2", - "resolved": "https://registry.npmjs.org/@esbuild/netbsd-x64/-/netbsd-x64-0.24.2.tgz", - "integrity": "sha512-VefFaQUc4FMmJuAxmIHgUmfNiLXY438XrL4GDNV1Y1H/RW3qow68xTwjZKfj/+Plp9NANmzbH5R40Meudu8mmw==", - "cpu": [ - "x64" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "netbsd" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/vite/node_modules/@esbuild/openbsd-arm64": { - "version": "0.24.2", - "resolved": "https://registry.npmjs.org/@esbuild/openbsd-arm64/-/openbsd-arm64-0.24.2.tgz", - "integrity": "sha512-YQbi46SBct6iKnszhSvdluqDmxCJA+Pu280Av9WICNwQmMxV7nLRHZfjQzwbPs3jeWnuAhE9Jy0NrnJ12Oz+0A==", - "cpu": [ - "arm64" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "openbsd" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/vite/node_modules/@esbuild/openbsd-x64": { - "version": "0.24.2", - "resolved": "https://registry.npmjs.org/@esbuild/openbsd-x64/-/openbsd-x64-0.24.2.tgz", - "integrity": "sha512-+iDS6zpNM6EnJyWv0bMGLWSWeXGN/HTaF/LXHXHwejGsVi+ooqDfMCCTerNFxEkM3wYVcExkeGXNqshc9iMaOA==", - "cpu": [ - "x64" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "openbsd" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/vite/node_modules/@esbuild/sunos-x64": { - "version": "0.24.2", - "resolved": "https://registry.npmjs.org/@esbuild/sunos-x64/-/sunos-x64-0.24.2.tgz", - "integrity": "sha512-hTdsW27jcktEvpwNHJU4ZwWFGkz2zRJUz8pvddmXPtXDzVKTTINmlmga3ZzwcuMpUvLw7JkLy9QLKyGpD2Yxig==", - "cpu": [ - "x64" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "sunos" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/vite/node_modules/@esbuild/win32-arm64": { - "version": "0.24.2", - "resolved": "https://registry.npmjs.org/@esbuild/win32-arm64/-/win32-arm64-0.24.2.tgz", - "integrity": "sha512-LihEQ2BBKVFLOC9ZItT9iFprsE9tqjDjnbulhHoFxYQtQfai7qfluVODIYxt1PgdoyQkz23+01rzwNwYfutxUQ==", - "cpu": [ - "arm64" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "win32" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/vite/node_modules/@esbuild/win32-ia32": { - "version": "0.24.2", - "resolved": "https://registry.npmjs.org/@esbuild/win32-ia32/-/win32-ia32-0.24.2.tgz", - "integrity": "sha512-q+iGUwfs8tncmFC9pcnD5IvRHAzmbwQ3GPS5/ceCyHdjXubwQWI12MKWSNSMYLJMq23/IUCvJMS76PDqXe1fxA==", - "cpu": [ - "ia32" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "win32" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/vite/node_modules/@esbuild/win32-x64": { - "version": "0.24.2", - "resolved": "https://registry.npmjs.org/@esbuild/win32-x64/-/win32-x64-0.24.2.tgz", - "integrity": "sha512-7VTgWzgMGvup6aSqDPLiW5zHaxYJGTO4OokMjIlrCtf+VpEL+cXKtCvg723iguPYI5oaUNdS+/V7OU2gvXVWEg==", - "cpu": [ - "x64" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "win32" - ], - "engines": { - "node": ">=18" - } - }, - "node_modules/vite/node_modules/esbuild": { - "version": "0.24.2", - "resolved": "https://registry.npmjs.org/esbuild/-/esbuild-0.24.2.tgz", - "integrity": "sha512-+9egpBW8I3CD5XPe0n6BfT5fxLzxrlDzqydF3aviG+9ni1lDC/OvMHcxqEFV0+LANZG5R1bFMWfUrjVsdwxJvA==", - "dev": true, - "hasInstallScript": true, - "license": "MIT", - "bin": { - "esbuild": "bin/esbuild" - }, - "engines": { - "node": ">=18" - }, - "optionalDependencies": { - "@esbuild/aix-ppc64": "0.24.2", - "@esbuild/android-arm": "0.24.2", - "@esbuild/android-arm64": "0.24.2", - "@esbuild/android-x64": "0.24.2", - "@esbuild/darwin-arm64": "0.24.2", - "@esbuild/darwin-x64": "0.24.2", - "@esbuild/freebsd-arm64": "0.24.2", - "@esbuild/freebsd-x64": "0.24.2", - "@esbuild/linux-arm": "0.24.2", - "@esbuild/linux-arm64": "0.24.2", - "@esbuild/linux-ia32": "0.24.2", - "@esbuild/linux-loong64": "0.24.2", - "@esbuild/linux-mips64el": "0.24.2", - "@esbuild/linux-ppc64": "0.24.2", - "@esbuild/linux-riscv64": "0.24.2", - "@esbuild/linux-s390x": "0.24.2", - "@esbuild/linux-x64": "0.24.2", - "@esbuild/netbsd-arm64": "0.24.2", - "@esbuild/netbsd-x64": "0.24.2", - "@esbuild/openbsd-arm64": "0.24.2", - "@esbuild/openbsd-x64": "0.24.2", - "@esbuild/sunos-x64": "0.24.2", - "@esbuild/win32-arm64": "0.24.2", - "@esbuild/win32-ia32": "0.24.2", - "@esbuild/win32-x64": "0.24.2" - } - }, "node_modules/vitest": { "version": "3.0.5", "resolved": "https://registry.npmjs.org/vitest/-/vitest-3.0.5.tgz", From 4c8a16678ef12a1f55b1b58d538ed62265406143 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Thu, 10 Apr 2025 00:30:49 -0400 Subject: [PATCH 3/3] feat: add new organization campaign endpoints, remove deprecated endpoints (#797) BREAKING CHANGE: remove deprecated copilot metrics endpoints BREAKING CHANGE: remove deprecated legacy projects endpoints --------- Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: wolfy1339 --- docs/campaigns/createCampaign.md | 101 ++ docs/campaigns/deleteCampaign.md | 48 + docs/campaigns/getCampaignSummary.md | 48 + docs/campaigns/listOrgCampaigns.md | 67 + docs/campaigns/updateCampaign.md | 83 ++ docs/issues/create.md | 2 +- docs/issues/update.md | 2 +- docs/orgs/createIssueType.md | 8 +- docs/orgs/deleteIssueType.md | 3 + docs/orgs/listIssueTypes.md | 2 +- docs/orgs/updateIssueType.md | 8 +- docs/repos/createOrgRuleset.md | 7 +- docs/repos/createRepoRuleset.md | 7 +- .../listPullRequestsAssociatedWithCommit.md | 2 +- docs/repos/removeCollaborator.md | 4 +- docs/repos/update.md | 10 + docs/repos/updateOrgRuleset.md | 7 +- docs/repos/updateRepoRuleset.md | 7 +- package-lock.json | 74 +- package.json | 2 +- .../update-endpoints/generated/endpoints.json | 1275 +++++++++++------ src/generated/endpoints.ts | 275 +--- src/generated/method-types.ts | 628 ++------ .../parameters-and-response-types.ts | 204 +-- 24 files changed, 1391 insertions(+), 1483 deletions(-) create mode 100644 docs/campaigns/createCampaign.md create mode 100644 docs/campaigns/deleteCampaign.md create mode 100644 docs/campaigns/getCampaignSummary.md create mode 100644 docs/campaigns/listOrgCampaigns.md create mode 100644 docs/campaigns/updateCampaign.md diff --git a/docs/campaigns/createCampaign.md b/docs/campaigns/createCampaign.md new file mode 100644 index 00000000..b1144085 --- /dev/null +++ b/docs/campaigns/createCampaign.md @@ -0,0 +1,101 @@ +--- +name: Create a campaign for an organization +example: octokit.rest.campaigns.createCampaign({ org, name, description, ends_at, code_scanning_alerts, code_scanning_alerts[].repository_id, code_scanning_alerts[].alert_numbers }) +route: POST /orgs/{org}/campaigns +scope: campaigns +type: API method +--- + +# Create a campaign for an organization + +Create a campaign for an organization. + +The authenticated user must be an owner or security manager for the organization to use this endpoint. + +OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. + +Fine-grained tokens must have the "Code scanning alerts" repository permissions (read) on all repositories included +in the campaign. + +```js +octokit.rest.campaigns.createCampaign({ + org, +name, +description, +ends_at, +code_scanning_alerts, +code_scanning_alerts[].repository_id, +code_scanning_alerts[].alert_numbers + }) +``` + +## Parameters + + + + + + + + + + + + + + + + + + + + + + +
namerequireddescription
orgyes + +The organization name. The name is not case sensitive. + +
nameyes + +The name of the campaign + +
descriptionyes + +A description for the campaign + +
managersno + +The logins of the users to set as the campaign managers. At this time, only a single manager can be supplied. + +
team_managersno + +The slugs of the teams to set as the campaign managers. + +
ends_atyes + +The end date and time of the campaign. The date must be in the future. + +
contact_linkno + +The contact link of the campaign. Must be a URI. + +
code_scanning_alertsyes + +The code scanning alerts to include in this campaign + +
code_scanning_alerts[].repository_idyes + +The repository id + +
code_scanning_alerts[].alert_numbersyes + +The alert numbers + +
generate_issuesno + +If true, will automatically generate issues for the campaign. The default is false. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/campaigns/campaigns#create-a-campaign-for-an-organization). diff --git a/docs/campaigns/deleteCampaign.md b/docs/campaigns/deleteCampaign.md new file mode 100644 index 00000000..141df57f --- /dev/null +++ b/docs/campaigns/deleteCampaign.md @@ -0,0 +1,48 @@ +--- +name: Delete a campaign for an organization +example: octokit.rest.campaigns.deleteCampaign({ org, campaign_number }) +route: DELETE /orgs/{org}/campaigns/{campaign_number} +scope: campaigns +type: API method +--- + +# Delete a campaign for an organization + +Deletes a campaign in an organization. + +The authenticated user must be an owner or security manager for the organization to use this endpoint. + +OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. + +```js +octokit.rest.campaigns.deleteCampaign({ + org, + campaign_number, +}); +``` + +## Parameters + + + + + + + + + + + + + +
namerequireddescription
orgyes + +The organization name. The name is not case sensitive. + +
campaign_numberyes + +The campaign number. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/campaigns/campaigns#delete-a-campaign-for-an-organization). diff --git a/docs/campaigns/getCampaignSummary.md b/docs/campaigns/getCampaignSummary.md new file mode 100644 index 00000000..ae3db85e --- /dev/null +++ b/docs/campaigns/getCampaignSummary.md @@ -0,0 +1,48 @@ +--- +name: Get a campaign for an organization +example: octokit.rest.campaigns.getCampaignSummary({ org, campaign_number }) +route: GET /orgs/{org}/campaigns/{campaign_number} +scope: campaigns +type: API method +--- + +# Get a campaign for an organization + +Gets a campaign for an organization. + +The authenticated user must be an owner or security manager for the organization to use this endpoint. + +OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. + +```js +octokit.rest.campaigns.getCampaignSummary({ + org, + campaign_number, +}); +``` + +## Parameters + + + + + + + + + + + + + +
namerequireddescription
orgyes + +The organization name. The name is not case sensitive. + +
campaign_numberyes + +The campaign number. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/campaigns/campaigns#get-a-campaign-for-an-organization). diff --git a/docs/campaigns/listOrgCampaigns.md b/docs/campaigns/listOrgCampaigns.md new file mode 100644 index 00000000..88efbb1b --- /dev/null +++ b/docs/campaigns/listOrgCampaigns.md @@ -0,0 +1,67 @@ +--- +name: List campaigns for an organization +example: octokit.rest.campaigns.listOrgCampaigns({ org }) +route: GET /orgs/{org}/campaigns +scope: campaigns +type: API method +--- + +# List campaigns for an organization + +Lists campaigns in an organization. + +The authenticated user must be an owner or security manager for the organization to use this endpoint. + +OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. + +```js +octokit.rest.campaigns.listOrgCampaigns({ + org, +}); +``` + +## Parameters + + + + + + + + + + + + + + + + + +
namerequireddescription
orgyes + +The organization name. The name is not case sensitive. + +
pageno + +The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + +
per_pageno + +The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + +
directionno + +The direction to sort the results by. + +
stateno + +If specified, only campaigns with this state will be returned. + +
sortno + +The property by which to sort the results. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/campaigns/campaigns#list-campaigns-for-an-organization). diff --git a/docs/campaigns/updateCampaign.md b/docs/campaigns/updateCampaign.md new file mode 100644 index 00000000..b6001c38 --- /dev/null +++ b/docs/campaigns/updateCampaign.md @@ -0,0 +1,83 @@ +--- +name: Update a campaign +example: octokit.rest.campaigns.updateCampaign({ org, campaign_number }) +route: PATCH /orgs/{org}/campaigns/{campaign_number} +scope: campaigns +type: API method +--- + +# Update a campaign + +Updates a campaign in an organization. + +The authenticated user must be an owner or security manager for the organization to use this endpoint. + +OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. + +```js +octokit.rest.campaigns.updateCampaign({ + org, + campaign_number, +}); +``` + +## Parameters + + + + + + + + + + + + + + + + + + + + +
namerequireddescription
orgyes + +The organization name. The name is not case sensitive. + +
campaign_numberyes + +The campaign number. + +
nameno + +The name of the campaign + +
descriptionno + +A description for the campaign + +
managersno + +The logins of the users to set as the campaign managers. At this time, only a single manager can be supplied. + +
team_managersno + +The slugs of the teams to set as the campaign managers. + +
ends_atno + +The end date and time of the campaign, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + +
contact_linkno + +The contact link of the campaign. Must be a URI. + +
stateno + +Indicates whether a campaign is open or closed + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/campaigns/campaigns#update-a-campaign). diff --git a/docs/issues/create.md b/docs/issues/create.md index cdc9bf8d..babd1973 100644 --- a/docs/issues/create.md +++ b/docs/issues/create.md @@ -79,7 +79,7 @@ Logins for Users to assign to this issue. _NOTE: Only users with push access can typeno -The name of the issue type to associate with this issue. +The name of the issue type to associate with this issue. _NOTE: Only users with push access can set the type for new issues. The type is silently dropped otherwise._ diff --git a/docs/issues/update.md b/docs/issues/update.md index b90366bc..4bff486d 100644 --- a/docs/issues/update.md +++ b/docs/issues/update.md @@ -91,7 +91,7 @@ Usernames to assign to this issue. Pass one or more user logins to _replace_ the typeno -The name of the issue type to associate with this issue or use `null` to remove the current issue type. +The name of the issue type to associate with this issue or use `null` to remove the current issue type. Only users with push access can set the type for issues. Without push access to the repository, type changes are silently dropped. diff --git a/docs/orgs/createIssueType.md b/docs/orgs/createIssueType.md index 3921700f..25a3d9b2 100644 --- a/docs/orgs/createIssueType.md +++ b/docs/orgs/createIssueType.md @@ -12,6 +12,9 @@ Create a new issue type for an organization. You can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization). +To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and +personal access tokens (classic) need the `admin:org` scope to use this endpoint. + ```js octokit.rest.orgs.createIssueType({ org, @@ -45,11 +48,6 @@ Name of the issue type. Whether or not the issue type is enabled at the organization level. - -is_privateno - -Whether or not the issue type is restricted to issues in private repositories. - descriptionno diff --git a/docs/orgs/deleteIssueType.md b/docs/orgs/deleteIssueType.md index d6d77a48..cae5e3a3 100644 --- a/docs/orgs/deleteIssueType.md +++ b/docs/orgs/deleteIssueType.md @@ -12,6 +12,9 @@ Deletes an issue type for an organization. You can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization). +To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and +personal access tokens (classic) need the `admin:org` scope to use this endpoint. + ```js octokit.rest.orgs.deleteIssueType({ org, diff --git a/docs/orgs/listIssueTypes.md b/docs/orgs/listIssueTypes.md index 199eff9b..ba2914c7 100644 --- a/docs/orgs/listIssueTypes.md +++ b/docs/orgs/listIssueTypes.md @@ -8,7 +8,7 @@ type: API method # List issue types for an organization -Lists all issue types for an organization. +Lists all issue types for an organization. OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint. ```js octokit.rest.orgs.listIssueTypes({ diff --git a/docs/orgs/updateIssueType.md b/docs/orgs/updateIssueType.md index e7b8e387..fc8b522a 100644 --- a/docs/orgs/updateIssueType.md +++ b/docs/orgs/updateIssueType.md @@ -12,6 +12,9 @@ Updates an issue type for an organization. You can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization). +To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and +personal access tokens (classic) need the `admin:org` scope to use this endpoint. + ```js octokit.rest.orgs.updateIssueType({ org, @@ -51,11 +54,6 @@ Name of the issue type. Whether or not the issue type is enabled at the organization level. - -is_privateno - -Whether or not the issue type is restricted to issues in private repositories. - descriptionno diff --git a/docs/repos/createOrgRuleset.md b/docs/repos/createOrgRuleset.md index 93fb1343..745fce9d 100644 --- a/docs/repos/createOrgRuleset.md +++ b/docs/repos/createOrgRuleset.md @@ -169,6 +169,11 @@ The environments that must be successfully deployed to before branches can be me Array of allowed merge methods. Allowed values include `merge`, `squash`, and `rebase`. At least one option must be enabled. + +rules[].parameters.automatic_copilot_code_review_enabledno + +Automatically request review from Copilot for new pull requests, if the author has access to Copilot code review. + rules[].parameters.dismiss_stale_reviews_on_pushyes @@ -247,7 +252,7 @@ The file paths that are restricted from being pushed to the commit graph. rules[].parameters.max_file_path_lengthyes -The maximum amount of characters allowed in file paths +The maximum amount of characters allowed in file paths. rules[].parameters.restricted_file_extensionsyes diff --git a/docs/repos/createRepoRuleset.md b/docs/repos/createRepoRuleset.md index 20e6c68d..964592f8 100644 --- a/docs/repos/createRepoRuleset.md +++ b/docs/repos/createRepoRuleset.md @@ -185,6 +185,11 @@ The environments that must be successfully deployed to before branches can be me Array of allowed merge methods. Allowed values include `merge`, `squash`, and `rebase`. At least one option must be enabled. + +rules[].parameters.automatic_copilot_code_review_enabledno + +Automatically request review from Copilot for new pull requests, if the author has access to Copilot code review. + rules[].parameters.dismiss_stale_reviews_on_pushyes @@ -263,7 +268,7 @@ The file paths that are restricted from being pushed to the commit graph. rules[].parameters.max_file_path_lengthyes -The maximum amount of characters allowed in file paths +The maximum amount of characters allowed in file paths. rules[].parameters.restricted_file_extensionsyes diff --git a/docs/repos/listPullRequestsAssociatedWithCommit.md b/docs/repos/listPullRequestsAssociatedWithCommit.md index fc52f1ae..0d95741d 100644 --- a/docs/repos/listPullRequestsAssociatedWithCommit.md +++ b/docs/repos/listPullRequestsAssociatedWithCommit.md @@ -8,7 +8,7 @@ type: API method # List pull requests associated with a commit -Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, will only return open pull requests associated with the commit. +Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, it will return merged and open pull requests associated with the commit. To list the open or merged pull requests associated with a branch, you can set the `commit_sha` parameter to the branch name. diff --git a/docs/repos/removeCollaborator.md b/docs/repos/removeCollaborator.md index ff9ffe2e..5c8119af 100644 --- a/docs/repos/removeCollaborator.md +++ b/docs/repos/removeCollaborator.md @@ -14,8 +14,8 @@ To use this endpoint, the authenticated user must either be an administrator of This endpoint also: -- Cancels any outstanding invitations -- Unasigns the user from any issues +- Cancels any outstanding invitations sent by the collaborator +- Unassigns the user from any issues - Removes access to organization projects if the user is not an organization member and is not a collaborator on any other organization repositories. - Unstars the repository - Updates access permissions to packages diff --git a/docs/repos/update.md b/docs/repos/update.md index bcc583b8..86db822c 100644 --- a/docs/repos/update.md +++ b/docs/repos/update.md @@ -85,6 +85,16 @@ Use the `status` property to enable or disable GitHub Advanced Security for this Can be `enabled` or `disabled`. + +security_and_analysis.code_securityno + +Use the `status` property to enable or disable GitHub Code Security for this repository. + + +security_and_analysis.code_security.statusno + +Can be `enabled` or `disabled`. + security_and_analysis.secret_scanningno diff --git a/docs/repos/updateOrgRuleset.md b/docs/repos/updateOrgRuleset.md index 0bbd5c04..15a363b1 100644 --- a/docs/repos/updateOrgRuleset.md +++ b/docs/repos/updateOrgRuleset.md @@ -173,6 +173,11 @@ The environments that must be successfully deployed to before branches can be me Array of allowed merge methods. Allowed values include `merge`, `squash`, and `rebase`. At least one option must be enabled. + +rules[].parameters.automatic_copilot_code_review_enabledno + +Automatically request review from Copilot for new pull requests, if the author has access to Copilot code review. + rules[].parameters.dismiss_stale_reviews_on_pushyes @@ -251,7 +256,7 @@ The file paths that are restricted from being pushed to the commit graph. rules[].parameters.max_file_path_lengthyes -The maximum amount of characters allowed in file paths +The maximum amount of characters allowed in file paths. rules[].parameters.restricted_file_extensionsyes diff --git a/docs/repos/updateRepoRuleset.md b/docs/repos/updateRepoRuleset.md index 2621fbc8..912ab694 100644 --- a/docs/repos/updateRepoRuleset.md +++ b/docs/repos/updateRepoRuleset.md @@ -189,6 +189,11 @@ The environments that must be successfully deployed to before branches can be me Array of allowed merge methods. Allowed values include `merge`, `squash`, and `rebase`. At least one option must be enabled. + +rules[].parameters.automatic_copilot_code_review_enabledno + +Automatically request review from Copilot for new pull requests, if the author has access to Copilot code review. + rules[].parameters.dismiss_stale_reviews_on_pushyes @@ -267,7 +272,7 @@ The file paths that are restricted from being pushed to the commit graph. rules[].parameters.max_file_path_lengthyes -The maximum amount of characters allowed in file paths +The maximum amount of characters allowed in file paths. rules[].parameters.restricted_file_extensionsyes diff --git a/package-lock.json b/package-lock.json index 5179a09d..9f4dafd7 100644 --- a/package-lock.json +++ b/package-lock.json @@ -9,7 +9,7 @@ "version": "0.0.0-development", "license": "MIT", "dependencies": { - "@octokit/types": "^13.10.0" + "@octokit/types": "^14.0.0" }, "devDependencies": { "@octokit/core": "^6.0.0", @@ -692,17 +692,17 @@ } }, "node_modules/@octokit/core": { - "version": "6.1.3", - "resolved": "https://registry.npmjs.org/@octokit/core/-/core-6.1.3.tgz", - "integrity": "sha512-z+j7DixNnfpdToYsOutStDgeRzJSMnbj8T1C/oQjB6Aa+kRfNjs/Fn7W6c8bmlt6mfy3FkgeKBRnDjxQow5dow==", + "version": "6.1.5", + "resolved": "https://registry.npmjs.org/@octokit/core/-/core-6.1.5.tgz", + "integrity": "sha512-vvmsN0r7rguA+FySiCsbaTTobSftpIDIpPW81trAmsv9TGxg3YCujAxRYp/Uy8xmDgYCzzgulG62H7KYUFmeIg==", "dev": true, "license": "MIT", "dependencies": { "@octokit/auth-token": "^5.0.0", - "@octokit/graphql": "^8.1.2", - "@octokit/request": "^9.1.4", - "@octokit/request-error": "^6.1.6", - "@octokit/types": "^13.6.2", + "@octokit/graphql": "^8.2.2", + "@octokit/request": "^9.2.3", + "@octokit/request-error": "^6.1.8", + "@octokit/types": "^14.0.0", "before-after-hook": "^3.0.2", "universal-user-agent": "^7.0.0" }, @@ -711,13 +711,13 @@ } }, "node_modules/@octokit/endpoint": { - "version": "10.1.2", - "resolved": "https://registry.npmjs.org/@octokit/endpoint/-/endpoint-10.1.2.tgz", - "integrity": "sha512-XybpFv9Ms4hX5OCHMZqyODYqGTZ3H6K6Vva+M9LR7ib/xr1y1ZnlChYv9H680y77Vd/i/k+thXApeRASBQkzhA==", + "version": "10.1.4", + "resolved": "https://registry.npmjs.org/@octokit/endpoint/-/endpoint-10.1.4.tgz", + "integrity": "sha512-OlYOlZIsfEVZm5HCSR8aSg02T2lbUWOsCQoPKfTXJwDzcHQBrVBGdGXb89dv2Kw2ToZaRtudp8O3ZIYoaOjKlA==", "dev": true, "license": "MIT", "dependencies": { - "@octokit/types": "^13.6.2", + "@octokit/types": "^14.0.0", "universal-user-agent": "^7.0.2" }, "engines": { @@ -725,36 +725,30 @@ } }, "node_modules/@octokit/graphql": { - "version": "8.2.0", - "resolved": "https://registry.npmjs.org/@octokit/graphql/-/graphql-8.2.0.tgz", - "integrity": "sha512-gejfDywEml/45SqbWTWrhfwvLBrcGYhOn50sPOjIeVvH6i7D16/9xcFA8dAJNp2HMcd+g4vru41g4E2RBiZvfQ==", + "version": "8.2.2", + "resolved": "https://registry.npmjs.org/@octokit/graphql/-/graphql-8.2.2.tgz", + "integrity": "sha512-Yi8hcoqsrXGdt0yObxbebHXFOiUA+2v3n53epuOg1QUgOB6c4XzvisBNVXJSl8RYA5KrDuSL2yq9Qmqe5N0ryA==", "dev": true, "license": "MIT", "dependencies": { - "@octokit/request": "^9.1.4", - "@octokit/types": "^13.8.0", + "@octokit/request": "^9.2.3", + "@octokit/types": "^14.0.0", "universal-user-agent": "^7.0.0" }, "engines": { "node": ">= 18" } }, - "node_modules/@octokit/openapi-types": { - "version": "24.2.0", - "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-24.2.0.tgz", - "integrity": "sha512-9sIH3nSUttelJSXUrmGzl7QUBFul0/mB8HRYl3fOlgHbIWG+WnYDXU3v/2zMtAvuzZ/ed00Ei6on975FhBfzrg==", - "license": "MIT" - }, "node_modules/@octokit/request": { - "version": "9.2.0", - "resolved": "https://registry.npmjs.org/@octokit/request/-/request-9.2.0.tgz", - "integrity": "sha512-kXLfcxhC4ozCnAXy2ff+cSxpcF0A1UqxjvYMqNuPIeOAzJbVWQ+dy5G2fTylofB/gTbObT8O6JORab+5XtA1Kw==", + "version": "9.2.3", + "resolved": "https://registry.npmjs.org/@octokit/request/-/request-9.2.3.tgz", + "integrity": "sha512-Ma+pZU8PXLOEYzsWf0cn/gY+ME57Wq8f49WTXA8FMHp2Ps9djKw//xYJ1je8Hm0pR2lU9FUGeJRWOtxq6olt4w==", "dev": true, "license": "MIT", "dependencies": { - "@octokit/endpoint": "^10.0.0", - "@octokit/request-error": "^6.0.1", - "@octokit/types": "^13.6.2", + "@octokit/endpoint": "^10.1.4", + "@octokit/request-error": "^6.1.8", + "@octokit/types": "^14.0.0", "fast-content-type-parse": "^2.0.0", "universal-user-agent": "^7.0.2" }, @@ -763,13 +757,13 @@ } }, "node_modules/@octokit/request-error": { - "version": "6.1.6", - "resolved": "https://registry.npmjs.org/@octokit/request-error/-/request-error-6.1.6.tgz", - "integrity": "sha512-pqnVKYo/at0NuOjinrgcQYpEbv4snvP3bKMRqHaD9kIsk9u1LCpb2smHZi8/qJfgeNqLo5hNW4Z7FezNdEo0xg==", + "version": "6.1.8", + "resolved": "https://registry.npmjs.org/@octokit/request-error/-/request-error-6.1.8.tgz", + "integrity": "sha512-WEi/R0Jmq+IJKydWlKDmryPcmdYSVjL3ekaiEL1L9eo1sUnqMJ+grqmC9cjk7CA7+b2/T397tO5d8YLOH3qYpQ==", "dev": true, "license": "MIT", "dependencies": { - "@octokit/types": "^13.6.2" + "@octokit/types": "^14.0.0" }, "engines": { "node": ">= 18" @@ -783,14 +777,20 @@ "license": "MIT" }, "node_modules/@octokit/types": { - "version": "13.10.0", - "resolved": "https://registry.npmjs.org/@octokit/types/-/types-13.10.0.tgz", - "integrity": "sha512-ifLaO34EbbPj0Xgro4G5lP5asESjwHracYJvVaPIyXMuiuXLlhic3S47cBdTb+jfODkTE5YtGCLt3Ay3+J97sA==", + "version": "14.0.0", + "resolved": "https://registry.npmjs.org/@octokit/types/-/types-14.0.0.tgz", + "integrity": "sha512-VVmZP0lEhbo2O1pdq63gZFiGCKkm8PPp8AUOijlwPO6hojEVjspA0MWKP7E4hbvGxzFKNqKr6p0IYtOH/Wf/zA==", "license": "MIT", "dependencies": { - "@octokit/openapi-types": "^24.2.0" + "@octokit/openapi-types": "^25.0.0" } }, + "node_modules/@octokit/types/node_modules/@octokit/openapi-types": { + "version": "25.0.0", + "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-25.0.0.tgz", + "integrity": "sha512-FZvktFu7HfOIJf2BScLKIEYjDsw6RKc7rBJCdvCTfKsVnx2GEB/Nbzjr29DUdb7vQhlzS/j8qDzdditP0OC6aw==", + "license": "MIT" + }, "node_modules/@pkgjs/parseargs": { "version": "0.11.0", "resolved": "https://registry.npmjs.org/@pkgjs/parseargs/-/parseargs-0.11.0.tgz", diff --git a/package.json b/package.json index 8dabc9fc..7987a5ca 100644 --- a/package.json +++ b/package.json @@ -25,7 +25,7 @@ "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", "dependencies": { - "@octokit/types": "^13.10.0" + "@octokit/types": "^14.0.0" }, "devDependencies": { "@octokit/core": "^6.0.0", diff --git a/scripts/update-endpoints/generated/endpoints.json b/scripts/update-endpoints/generated/endpoints.json index 075e196b..0e5cd819 100644 --- a/scripts/update-endpoints/generated/endpoints.json +++ b/scripts/update-endpoints/generated/endpoints.json @@ -15647,6 +15647,544 @@ ], "renamed": null }, + { + "name": "Create a campaign for an organization", + "scope": "campaigns", + "id": "createCampaign", + "method": "POST", + "url": "/orgs/{org}/campaigns", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Create a campaign for an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.\n\nFine-grained tokens must have the \"Code scanning alerts\" repository permissions (read) on all repositories included\nin the campaign.", + "documentationUrl": "https://docs.github.com/rest/campaigns/campaigns#create-a-campaign-for-an-organization", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "name", + "description": "The name of the campaign", + "in": "BODY", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "description", + "description": "A description for the campaign", + "in": "BODY", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "managers", + "description": "The logins of the users to set as the campaign managers. At this time, only a single manager can be supplied.", + "in": "BODY", + "type": "string[]", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "team_managers", + "description": "The slugs of the teams to set as the campaign managers.", + "in": "BODY", + "type": "string[]", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "ends_at", + "description": "The end date and time of the campaign. The date must be in the future.", + "in": "BODY", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "contact_link", + "description": "The contact link of the campaign. Must be a URI.", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": true, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "code_scanning_alerts", + "description": "The code scanning alerts to include in this campaign", + "in": "BODY", + "type": "object[]", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "code_scanning_alerts[].repository_id", + "description": "The repository id", + "in": "BODY", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "code_scanning_alerts[].alert_numbers", + "description": "The alert numbers", + "in": "BODY", + "type": "integer[]", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "generate_issues", + "description": "If true, will automatically generate issues for the campaign. The default is false.", + "in": "BODY", + "type": "boolean", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"number\":3,\"created_at\":\"2024-02-14T12:29:18Z\",\"updated_at\":\"2024-02-14T12:29:18Z\",\"name\":\"Critical CodeQL alert\",\"description\":\"Address critical alerts before they are exploited to prevent breaches, protect sensitive data, and mitigate financial and reputational damage.\",\"managers\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"published_at\":\"2024-02-14T12:29:18Z\",\"ends_at\":\"2024-03-14T12:29:18Z\",\"closed_at\":null,\"state\":\"open\",\"alert_stats\":{\"open_count\":10,\"closed_count\":3,\"in_progress_count\":3}}" + } + ] + }, + { "code": 400, "description": "Bad Request", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null }, + { "code": 422, "description": "Unprocessable Entity", "examples": null }, + { "code": 429, "description": "Too Many Requests", "examples": null }, + { "code": 503, "description": "Service unavailable", "examples": null } + ], + "renamed": null + }, + { + "name": "Delete a campaign for an organization", + "scope": "campaigns", + "id": "deleteCampaign", + "method": "DELETE", + "url": "/orgs/{org}/campaigns/{campaign_number}", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Deletes a campaign in an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/campaigns/campaigns#delete-a-campaign-for-an-organization", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "campaign_number", + "description": "The campaign number.", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { "code": 204, "description": "Deletion successful", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null }, + { "code": 503, "description": "Service unavailable", "examples": null } + ], + "renamed": null + }, + { + "name": "Get a campaign for an organization", + "scope": "campaigns", + "id": "getCampaignSummary", + "method": "GET", + "url": "/orgs/{org}/campaigns/{campaign_number}", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Gets a campaign for an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/campaigns/campaigns#get-a-campaign-for-an-organization", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "campaign_number", + "description": "The campaign number.", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"number\":3,\"created_at\":\"2024-02-14T12:29:18Z\",\"updated_at\":\"2024-02-14T12:29:18Z\",\"name\":\"Critical CodeQL alert\",\"description\":\"Address critical alerts before they are exploited to prevent breaches, protect sensitive data, and mitigate financial and reputational damage.\",\"managers\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"published_at\":\"2024-02-14T12:29:18Z\",\"ends_at\":\"2024-03-14T12:29:18Z\",\"closed_at\":null,\"state\":\"open\",\"alert_stats\":{\"open_count\":10,\"closed_count\":3,\"in_progress_count\":3}}" + } + ] + }, + { "code": 404, "description": "Resource not found", "examples": null }, + { "code": 422, "description": "Unprocessable Entity", "examples": null }, + { "code": 503, "description": "Service unavailable", "examples": null } + ], + "renamed": null + }, + { + "name": "List campaigns for an organization", + "scope": "campaigns", + "id": "listOrgCampaigns", + "method": "GET", + "url": "/orgs/{org}/campaigns", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Lists campaigns in an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/campaigns/campaigns#list-campaigns-for-an-organization", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "direction", + "description": "The direction to sort the results by.", + "in": "QUERY", + "type": "string", + "required": false, + "enum": ["asc", "desc"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "state", + "description": "If specified, only campaigns with this state will be returned.", + "in": "QUERY", + "type": "string", + "required": false, + "enum": ["open", "closed"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "sort", + "description": "The property by which to sort the results.", + "in": "QUERY", + "type": "string", + "required": false, + "enum": ["created", "updated", "ends_at", "published"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "[{\"number\":3,\"created_at\":\"2024-02-14T12:29:18Z\",\"updated_at\":\"2024-02-14T12:29:18Z\",\"name\":\"Critical CodeQL alert\",\"description\":\"Address critical alerts before they are exploited to prevent breaches, protect sensitive data, and mitigate financial and reputational damage.\",\"managers\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"ends_at\":\"2024-03-14T12:29:18Z\",\"closed_at\":null,\"state\":\"open\"},{\"number\":4,\"created_at\":\"2024-03-30T12:29:18Z\",\"updated_at\":\"2024-03-30T12:29:18Z\",\"name\":\"Mitre top 10 KEV\",\"description\":\"Remediate the MITRE Top 10 KEV (Known Exploited Vulnerabilities) to enhance security by addressing vulnerabilities actively exploited by attackers. This reduces risk, prevents breaches and can help protect sensitive data.\",\"managers\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"ends_at\":\"2024-04-30T12:29:18Z\",\"closed_at\":null,\"state\":\"open\"}]" + } + ] + }, + { "code": 404, "description": "Resource not found", "examples": null }, + { "code": 503, "description": "Service unavailable", "examples": null } + ], + "renamed": null + }, + { + "name": "Update a campaign", + "scope": "campaigns", + "id": "updateCampaign", + "method": "PATCH", + "url": "/orgs/{org}/campaigns/{campaign_number}", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Updates a campaign in an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/campaigns/campaigns#update-a-campaign", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "campaign_number", + "description": "The campaign number.", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "name", + "description": "The name of the campaign", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "description", + "description": "A description for the campaign", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "managers", + "description": "The logins of the users to set as the campaign managers. At this time, only a single manager can be supplied.", + "in": "BODY", + "type": "string[]", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "team_managers", + "description": "The slugs of the teams to set as the campaign managers.", + "in": "BODY", + "type": "string[]", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "ends_at", + "description": "The end date and time of the campaign, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "contact_link", + "description": "The contact link of the campaign. Must be a URI.", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": true, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "state", + "description": "Indicates whether a campaign is open or closed", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["open", "closed"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"number\":3,\"created_at\":\"2024-02-14T12:29:18Z\",\"updated_at\":\"2024-02-14T12:29:18Z\",\"name\":\"Critical CodeQL alert\",\"description\":\"Address critical alerts before they are exploited to prevent breaches, protect sensitive data, and mitigate financial and reputational damage.\",\"managers\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"published_at\":\"2024-02-14T12:29:18Z\",\"ends_at\":\"2024-03-14T12:29:18Z\",\"closed_at\":null,\"state\":\"open\",\"alert_stats\":{\"open_count\":10,\"closed_count\":3,\"in_progress_count\":3}}" + } + ] + }, + { "code": 400, "description": "Bad Request", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null }, + { "code": 422, "description": "Unprocessable Entity", "examples": null }, + { "code": 503, "description": "Service unavailable", "examples": null } + ], + "renamed": null + }, { "name": "Create a check run", "scope": "checks", @@ -26613,418 +27151,203 @@ "description": "Response", "examples": [ { - "data": "[{\"date\":\"2024-06-24\",\"total_active_users\":24,\"total_engaged_users\":20,\"copilot_ide_code_completions\":{\"total_engaged_users\":20,\"languages\":[{\"name\":\"python\",\"total_engaged_users\":10},{\"name\":\"ruby\",\"total_engaged_users\":10}],\"editors\":[{\"name\":\"vscode\",\"total_engaged_users\":13,\"models\":[{\"name\":\"default\",\"is_custom_model\":false,\"custom_model_training_date\":null,\"total_engaged_users\":13,\"languages\":[{\"name\":\"python\",\"total_engaged_users\":6,\"total_code_suggestions\":249,\"total_code_acceptances\":123,\"total_code_lines_suggested\":225,\"total_code_lines_accepted\":135},{\"name\":\"ruby\",\"total_engaged_users\":7,\"total_code_suggestions\":496,\"total_code_acceptances\":253,\"total_code_lines_suggested\":520,\"total_code_lines_accepted\":270}]}]},{\"name\":\"neovim\",\"total_engaged_users\":7,\"models\":[{\"name\":\"a-custom-model\",\"is_custom_model\":true,\"custom_model_training_date\":\"2024-02-01\",\"languages\":[{\"name\":\"typescript\",\"total_engaged_users\":3,\"total_code_suggestions\":112,\"total_code_acceptances\":56,\"total_code_lines_suggested\":143,\"total_code_lines_accepted\":61},{\"name\":\"go\",\"total_engaged_users\":4,\"total_code_suggestions\":132,\"total_code_acceptances\":67,\"total_code_lines_suggested\":154,\"total_code_lines_accepted\":72}]}]}]},\"copilot_ide_chat\":{\"total_engaged_users\":13,\"editors\":[{\"name\":\"vscode\",\"total_engaged_users\":13,\"models\":[{\"name\":\"default\",\"is_custom_model\":false,\"custom_model_training_date\":null,\"total_engaged_users\":12,\"total_chats\":45,\"total_chat_insertion_events\":12,\"total_chat_copy_events\":16},{\"name\":\"a-custom-model\",\"is_custom_model\":true,\"custom_model_training_date\":\"2024-02-01\",\"total_engaged_users\":1,\"total_chats\":10,\"total_chat_insertion_events\":11,\"total_chat_copy_events\":3}]}]},\"copilot_dotcom_chat\":{\"total_engaged_users\":14,\"models\":[{\"name\":\"default\",\"is_custom_model\":false,\"custom_model_training_date\":null,\"total_engaged_users\":14,\"total_chats\":38}]},\"copilot_dotcom_pull_requests\":{\"total_engaged_users\":12,\"repositories\":[{\"name\":\"demo/repo1\",\"total_engaged_users\":8,\"models\":[{\"name\":\"default\",\"is_custom_model\":false,\"custom_model_training_date\":null,\"total_pr_summaries_created\":6,\"total_engaged_users\":8}]},{\"name\":\"demo/repo2\",\"total_engaged_users\":4,\"models\":[{\"name\":\"a-custom-model\",\"is_custom_model\":true,\"custom_model_training_date\":\"2024-02-01\",\"total_pr_summaries_created\":10,\"total_engaged_users\":4}]}]}}]" - } - ] - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Copilot Usage Merics API setting is disabled at the organization or enterprise level.", - "examples": null - }, - { "code": 500, "description": "Internal Error", "examples": null } - ], - "renamed": null - }, - { - "name": "Get Copilot seat information and settings for an organization", - "scope": "copilot", - "id": "getCopilotOrganizationDetails", - "method": "GET", - "url": "/orgs/{org}/copilot/billing", - "isDeprecated": false, - "deprecationDate": null, - "removalDate": null, - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets information about an organization's Copilot subscription, including seat breakdown\nand feature policies. To configure these settings, go to your organization's settings on GitHub.com.\nFor more information, see \"[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization).\"\n\nOnly organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/copilot/copilot-user-management#get-copilot-seat-information-and-settings-for-an-organization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "OK", - "examples": [ - { - "data": "{\"seat_breakdown\":{\"total\":12,\"added_this_cycle\":9,\"pending_invitation\":0,\"pending_cancellation\":0,\"active_this_cycle\":12,\"inactive_this_cycle\":11},\"seat_management_setting\":\"assign_selected\",\"ide_chat\":\"enabled\",\"platform_chat\":\"enabled\",\"cli\":\"enabled\",\"public_code_suggestions\":\"block\",\"plan_type\":\"business\"}" - } - ] - }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "There is a problem with your account's associated payment method.", - "examples": null - }, - { "code": 500, "description": "Internal Error", "examples": null } - ], - "renamed": null - }, - { - "name": "Get Copilot seat assignment details for a user", - "scope": "copilot", - "id": "getCopilotSeatDetailsForUser", - "method": "GET", - "url": "/orgs/{org}/members/{username}/copilot", - "isDeprecated": false, - "deprecationDate": null, - "removalDate": null, - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot.\n\nThe seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`.\nFor more information about activity data, see \"[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization).\"\n\nOnly organization owners can view Copilot seat assignment details for members of their organization.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/copilot/copilot-user-management#get-copilot-seat-assignment-details-for-a-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "The user's GitHub Copilot seat details, including usage.", - "examples": [ - { - "data": "{\"created_at\":\"2021-08-03T18:00:00-06:00\",\"updated_at\":\"2021-09-23T15:00:00-06:00\",\"pending_cancellation_date\":null,\"last_activity_at\":\"2021-10-14T00:53:32-06:00\",\"last_activity_editor\":\"vscode/1.77.3/copilot/1.86.82\",\"plan_type\":\"business\",\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assigning_team\":{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"notification_setting\":\"notifications_enabled\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}}" - } - ] - }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Copilot Business or Enterprise is not enabled for this organization or the user has a pending organization invitation.", - "examples": null - }, - { "code": 500, "description": "Internal Error", "examples": null } - ], - "renamed": null - }, - { - "name": "List all Copilot seat assignments for an organization", - "scope": "copilot", - "id": "listCopilotSeats", - "method": "GET", - "url": "/orgs/{org}/copilot/billing/seats", - "isDeprecated": false, - "deprecationDate": null, - "removalDate": null, - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists all Copilot seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed.\nOnly organization owners can view assigned seats.\n\nEach seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`.\nFor more information about activity data, see \"[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization).\"\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/copilot/copilot-user-management#list-all-copilot-seat-assignments-for-an-organization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_seats\":2,\"seats\":[{\"created_at\":\"2021-08-03T18:00:00-06:00\",\"updated_at\":\"2021-09-23T15:00:00-06:00\",\"pending_cancellation_date\":null,\"last_activity_at\":\"2021-10-14T00:53:32-06:00\",\"last_activity_editor\":\"vscode/1.77.3/copilot/1.86.82\",\"plan_type\":\"business\",\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assigning_team\":{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"notification_setting\":\"notifications_enabled\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}},{\"created_at\":\"2021-09-23T18:00:00-06:00\",\"updated_at\":\"2021-09-23T15:00:00-06:00\",\"pending_cancellation_date\":\"2021-11-01\",\"last_activity_at\":\"2021-10-13T00:53:32-06:00\",\"last_activity_editor\":\"vscode/1.77.3/copilot/1.86.82\",\"assignee\":{\"login\":\"octokitten\",\"id\":1,\"node_id\":\"MDQ76VNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octokitten_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octokitten\",\"html_url\":\"https://github.com/octokitten\",\"followers_url\":\"https://api.github.com/users/octokitten/followers\",\"following_url\":\"https://api.github.com/users/octokitten/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octokitten/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octokitten/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octokitten/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octokitten/orgs\",\"repos_url\":\"https://api.github.com/users/octokitten/repos\",\"events_url\":\"https://api.github.com/users/octokitten/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octokitten/received_events\",\"type\":\"User\",\"site_admin\":false}}]}" - } - ] - }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 500, "description": "Internal Error", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a summary of Copilot usage for organization members", - "scope": "copilot", - "id": "usageMetricsForOrg", - "method": "GET", - "url": "/orgs/{org}/copilot/usage", - "isDeprecated": false, - "deprecationDate": null, - "removalDate": null, - "description": "> [!NOTE]\n> This endpoint is closing down. It will be accessible throughout February 2025, but will not return any new data after February 1st.\n\nYou can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE\nacross an organization, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day.\nSee the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\nOrganization owners, and owners and billing managers of the parent enterprise, can view Copilot usage metrics.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/copilot/copilot-usage#get-a-summary-of-copilot-usage-for-organization-members", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "since", - "description": "Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "until", - "description": "Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of days of metrics to display per page (max 28). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"day\":\"2023-10-15\",\"total_suggestions_count\":1000,\"total_acceptances_count\":800,\"total_lines_suggested\":1800,\"total_lines_accepted\":1200,\"total_active_users\":10,\"total_chat_acceptances\":32,\"total_chat_turns\":200,\"total_active_chat_users\":4,\"breakdown\":[{\"language\":\"python\",\"editor\":\"vscode\",\"suggestions_count\":300,\"acceptances_count\":250,\"lines_suggested\":900,\"lines_accepted\":700,\"active_users\":5},{\"language\":\"python\",\"editor\":\"jetbrains\",\"suggestions_count\":300,\"acceptances_count\":200,\"lines_suggested\":400,\"lines_accepted\":300,\"active_users\":2},{\"language\":\"ruby\",\"editor\":\"vscode\",\"suggestions_count\":400,\"acceptances_count\":350,\"lines_suggested\":500,\"lines_accepted\":200,\"active_users\":3}]},{\"day\":\"2023-10-16\",\"total_suggestions_count\":800,\"total_acceptances_count\":600,\"total_lines_suggested\":1100,\"total_lines_accepted\":700,\"total_active_users\":12,\"total_chat_acceptances\":57,\"total_chat_turns\":426,\"total_active_chat_users\":8,\"breakdown\":[{\"language\":\"python\",\"editor\":\"vscode\",\"suggestions_count\":300,\"acceptances_count\":200,\"lines_suggested\":600,\"lines_accepted\":300,\"active_users\":2},{\"language\":\"python\",\"editor\":\"jetbrains\",\"suggestions_count\":300,\"acceptances_count\":150,\"lines_suggested\":300,\"lines_accepted\":250,\"active_users\":6},{\"language\":\"ruby\",\"editor\":\"vscode\",\"suggestions_count\":200,\"acceptances_count\":150,\"lines_suggested\":200,\"lines_accepted\":150,\"active_users\":3}]}]" - } - ] - }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 500, "description": "Internal Error", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a summary of Copilot usage for a team", - "scope": "copilot", - "id": "usageMetricsForTeam", - "method": "GET", - "url": "/orgs/{org}/team/{team_slug}/copilot/usage", - "isDeprecated": false, - "deprecationDate": null, - "removalDate": null, - "description": "> [!NOTE]\n> This endpoint is closing down. It will be accessible throughout February 2025, but will not return any new data after February 1st.\n\nYou can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE\nfor users within a team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day.\nSee the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the team had five or more members with active Copilot licenses, as evaluated at the end of that day.\n\nOrganization owners for the organization that contains this team, and owners and billing managers of the parent enterprise can view Copilot usage metrics for a team.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/copilot/copilot-usage#get-a-summary-of-copilot-usage-for-a-team", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "since", - "description": "Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "until", - "description": "Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of days of metrics to display per page (max 28). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"day\":\"2023-10-15\",\"total_suggestions_count\":1000,\"total_acceptances_count\":800,\"total_lines_suggested\":1800,\"total_lines_accepted\":1200,\"total_active_users\":10,\"total_chat_acceptances\":32,\"total_chat_turns\":200,\"total_active_chat_users\":4,\"breakdown\":[{\"language\":\"python\",\"editor\":\"vscode\",\"suggestions_count\":300,\"acceptances_count\":250,\"lines_suggested\":900,\"lines_accepted\":700,\"active_users\":5},{\"language\":\"python\",\"editor\":\"jetbrains\",\"suggestions_count\":300,\"acceptances_count\":200,\"lines_suggested\":400,\"lines_accepted\":300,\"active_users\":2},{\"language\":\"ruby\",\"editor\":\"vscode\",\"suggestions_count\":400,\"acceptances_count\":350,\"lines_suggested\":500,\"lines_accepted\":200,\"active_users\":3}]},{\"day\":\"2023-10-16\",\"total_suggestions_count\":800,\"total_acceptances_count\":600,\"total_lines_suggested\":1100,\"total_lines_accepted\":700,\"total_active_users\":12,\"total_chat_acceptances\":57,\"total_chat_turns\":426,\"total_active_chat_users\":8,\"breakdown\":[{\"language\":\"python\",\"editor\":\"vscode\",\"suggestions_count\":300,\"acceptances_count\":200,\"lines_suggested\":600,\"lines_accepted\":300,\"active_users\":2},{\"language\":\"python\",\"editor\":\"jetbrains\",\"suggestions_count\":300,\"acceptances_count\":150,\"lines_suggested\":300,\"lines_accepted\":250,\"active_users\":6},{\"language\":\"ruby\",\"editor\":\"vscode\",\"suggestions_count\":200,\"acceptances_count\":150,\"lines_suggested\":200,\"lines_accepted\":150,\"active_users\":3}]}]" + "data": "[{\"date\":\"2024-06-24\",\"total_active_users\":24,\"total_engaged_users\":20,\"copilot_ide_code_completions\":{\"total_engaged_users\":20,\"languages\":[{\"name\":\"python\",\"total_engaged_users\":10},{\"name\":\"ruby\",\"total_engaged_users\":10}],\"editors\":[{\"name\":\"vscode\",\"total_engaged_users\":13,\"models\":[{\"name\":\"default\",\"is_custom_model\":false,\"custom_model_training_date\":null,\"total_engaged_users\":13,\"languages\":[{\"name\":\"python\",\"total_engaged_users\":6,\"total_code_suggestions\":249,\"total_code_acceptances\":123,\"total_code_lines_suggested\":225,\"total_code_lines_accepted\":135},{\"name\":\"ruby\",\"total_engaged_users\":7,\"total_code_suggestions\":496,\"total_code_acceptances\":253,\"total_code_lines_suggested\":520,\"total_code_lines_accepted\":270}]}]},{\"name\":\"neovim\",\"total_engaged_users\":7,\"models\":[{\"name\":\"a-custom-model\",\"is_custom_model\":true,\"custom_model_training_date\":\"2024-02-01\",\"languages\":[{\"name\":\"typescript\",\"total_engaged_users\":3,\"total_code_suggestions\":112,\"total_code_acceptances\":56,\"total_code_lines_suggested\":143,\"total_code_lines_accepted\":61},{\"name\":\"go\",\"total_engaged_users\":4,\"total_code_suggestions\":132,\"total_code_acceptances\":67,\"total_code_lines_suggested\":154,\"total_code_lines_accepted\":72}]}]}]},\"copilot_ide_chat\":{\"total_engaged_users\":13,\"editors\":[{\"name\":\"vscode\",\"total_engaged_users\":13,\"models\":[{\"name\":\"default\",\"is_custom_model\":false,\"custom_model_training_date\":null,\"total_engaged_users\":12,\"total_chats\":45,\"total_chat_insertion_events\":12,\"total_chat_copy_events\":16},{\"name\":\"a-custom-model\",\"is_custom_model\":true,\"custom_model_training_date\":\"2024-02-01\",\"total_engaged_users\":1,\"total_chats\":10,\"total_chat_insertion_events\":11,\"total_chat_copy_events\":3}]}]},\"copilot_dotcom_chat\":{\"total_engaged_users\":14,\"models\":[{\"name\":\"default\",\"is_custom_model\":false,\"custom_model_training_date\":null,\"total_engaged_users\":14,\"total_chats\":38}]},\"copilot_dotcom_pull_requests\":{\"total_engaged_users\":12,\"repositories\":[{\"name\":\"demo/repo1\",\"total_engaged_users\":8,\"models\":[{\"name\":\"default\",\"is_custom_model\":false,\"custom_model_training_date\":null,\"total_pr_summaries_created\":6,\"total_engaged_users\":8}]},{\"name\":\"demo/repo2\",\"total_engaged_users\":4,\"models\":[{\"name\":\"a-custom-model\",\"is_custom_model\":true,\"custom_model_training_date\":\"2024-02-01\",\"total_pr_summaries_created\":10,\"total_engaged_users\":4}]}]}}]" + } + ] + }, + { "code": 403, "description": "Forbidden", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null }, + { + "code": 422, + "description": "Copilot Usage Merics API setting is disabled at the organization or enterprise level.", + "examples": null + }, + { "code": 500, "description": "Internal Error", "examples": null } + ], + "renamed": null + }, + { + "name": "Get Copilot seat information and settings for an organization", + "scope": "copilot", + "id": "getCopilotOrganizationDetails", + "method": "GET", + "url": "/orgs/{org}/copilot/billing", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets information about an organization's Copilot subscription, including seat breakdown\nand feature policies. To configure these settings, go to your organization's settings on GitHub.com.\nFor more information, see \"[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization).\"\n\nOnly organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/copilot/copilot-user-management#get-copilot-seat-information-and-settings-for-an-organization", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "OK", + "examples": [ + { + "data": "{\"seat_breakdown\":{\"total\":12,\"added_this_cycle\":9,\"pending_invitation\":0,\"pending_cancellation\":0,\"active_this_cycle\":12,\"inactive_this_cycle\":11},\"seat_management_setting\":\"assign_selected\",\"ide_chat\":\"enabled\",\"platform_chat\":\"enabled\",\"cli\":\"enabled\",\"public_code_suggestions\":\"block\",\"plan_type\":\"business\"}" + } + ] + }, + { + "code": 401, + "description": "Requires authentication", + "examples": null + }, + { "code": 403, "description": "Forbidden", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null }, + { + "code": 422, + "description": "There is a problem with your account's associated payment method.", + "examples": null + }, + { "code": 500, "description": "Internal Error", "examples": null } + ], + "renamed": null + }, + { + "name": "Get Copilot seat assignment details for a user", + "scope": "copilot", + "id": "getCopilotSeatDetailsForUser", + "method": "GET", + "url": "/orgs/{org}/members/{username}/copilot", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot.\n\nThe seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`.\nFor more information about activity data, see \"[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization).\"\n\nOnly organization owners can view Copilot seat assignment details for members of their organization.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/copilot/copilot-user-management#get-copilot-seat-assignment-details-for-a-user", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "The user's GitHub Copilot seat details, including usage.", + "examples": [ + { + "data": "{\"created_at\":\"2021-08-03T18:00:00-06:00\",\"updated_at\":\"2021-09-23T15:00:00-06:00\",\"pending_cancellation_date\":null,\"last_activity_at\":\"2021-10-14T00:53:32-06:00\",\"last_activity_editor\":\"vscode/1.77.3/copilot/1.86.82\",\"plan_type\":\"business\",\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assigning_team\":{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"notification_setting\":\"notifications_enabled\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}}" + } + ] + }, + { + "code": 401, + "description": "Requires authentication", + "examples": null + }, + { "code": 403, "description": "Forbidden", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null }, + { + "code": 422, + "description": "Copilot Business or Enterprise is not enabled for this organization or the user has a pending organization invitation.", + "examples": null + }, + { "code": 500, "description": "Internal Error", "examples": null } + ], + "renamed": null + }, + { + "name": "List all Copilot seat assignments for an organization", + "scope": "copilot", + "id": "listCopilotSeats", + "method": "GET", + "url": "/orgs/{org}/copilot/billing/seats", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists all Copilot seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed.\nOnly organization owners can view assigned seats.\n\nEach seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`.\nFor more information about activity data, see \"[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization).\"\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/copilot/copilot-user-management#list-all-copilot-seat-assignments-for-an-organization", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"total_seats\":2,\"seats\":[{\"created_at\":\"2021-08-03T18:00:00-06:00\",\"updated_at\":\"2021-09-23T15:00:00-06:00\",\"pending_cancellation_date\":null,\"last_activity_at\":\"2021-10-14T00:53:32-06:00\",\"last_activity_editor\":\"vscode/1.77.3/copilot/1.86.82\",\"plan_type\":\"business\",\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assigning_team\":{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"notification_setting\":\"notifications_enabled\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}},{\"created_at\":\"2021-09-23T18:00:00-06:00\",\"updated_at\":\"2021-09-23T15:00:00-06:00\",\"pending_cancellation_date\":\"2021-11-01\",\"last_activity_at\":\"2021-10-13T00:53:32-06:00\",\"last_activity_editor\":\"vscode/1.77.3/copilot/1.86.82\",\"assignee\":{\"login\":\"octokitten\",\"id\":1,\"node_id\":\"MDQ76VNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octokitten_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octokitten\",\"html_url\":\"https://github.com/octokitten\",\"followers_url\":\"https://api.github.com/users/octokitten/followers\",\"following_url\":\"https://api.github.com/users/octokitten/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octokitten/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octokitten/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octokitten/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octokitten/orgs\",\"repos_url\":\"https://api.github.com/users/octokitten/repos\",\"events_url\":\"https://api.github.com/users/octokitten/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octokitten/received_events\",\"type\":\"User\",\"site_admin\":false}}]}" } ] }, @@ -33655,7 +33978,7 @@ }, { "name": "type", - "description": "The name of the issue type to associate with this issue.", + "description": "The name of the issue type to associate with this issue. _NOTE: Only users with push access can set the type for new issues. The type is silently dropped otherwise._", "in": "BODY", "type": "string", "required": false, @@ -37127,7 +37450,7 @@ }, { "name": "type", - "description": "The name of the issue type to associate with this issue or use `null` to remove the current issue type.", + "description": "The name of the issue type to associate with this issue or use `null` to remove the current issue type. Only users with push access can set the type for issues. Without push access to the repository, type changes are silently dropped.", "in": "BODY", "type": "string", "required": false, @@ -40403,7 +40726,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Create a new issue type for an organization.\n\nYou can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization).", + "description": "Create a new issue type for an organization.\n\nYou can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization).\n\nTo use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the `admin:org` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/orgs/issue-types#create-issue-type-for-an-organization", "previews": [], "headers": [], @@ -40447,19 +40770,6 @@ "alias": null, "deprecated": null }, - { - "name": "is_private", - "description": "Whether or not the issue type is restricted to issues in private repositories.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, { "name": "description", "description": "Description of the issue type.", @@ -41143,7 +41453,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Deletes an issue type for an organization.\n\nYou can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization).", + "description": "Deletes an issue type for an organization.\n\nYou can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization).\n\nTo use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the `admin:org` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/orgs/issue-types#delete-issue-type-for-an-organization", "previews": [], "headers": [], @@ -42615,7 +42925,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists all issue types for an organization.", + "description": "Lists all issue types for an organization. OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/orgs/issue-types#list-issue-types-for-an-organization", "previews": [], "headers": [], @@ -45449,7 +45759,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Updates an issue type for an organization.\n\nYou can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization).", + "description": "Updates an issue type for an organization.\n\nYou can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization).\n\nTo use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the `admin:org` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/orgs/issue-types#update-issue-type-for-an-organization", "previews": [], "headers": [], @@ -45506,19 +45816,6 @@ "alias": null, "deprecated": null }, - { - "name": "is_private", - "description": "Whether or not the issue type is restricted to issues in private repositories.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, { "name": "description", "description": "Description of the issue type.", @@ -59917,6 +60214,19 @@ "alias": null, "deprecated": null }, + { + "name": "rules[].parameters.automatic_copilot_code_review_enabled", + "description": "Automatically request review from Copilot for new pull requests, if the author has access to Copilot code review.", + "in": "BODY", + "type": "boolean", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, { "name": "rules[].parameters.dismiss_stale_reviews_on_push", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals.", @@ -60114,7 +60424,7 @@ }, { "name": "rules[].parameters.max_file_path_length", - "description": "The maximum amount of characters allowed in file paths", + "description": "The maximum amount of characters allowed in file paths.", "in": "BODY", "type": "integer", "required": true, @@ -61068,6 +61378,19 @@ "alias": null, "deprecated": null }, + { + "name": "rules[].parameters.automatic_copilot_code_review_enabled", + "description": "Automatically request review from Copilot for new pull requests, if the author has access to Copilot code review.", + "in": "BODY", + "type": "boolean", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, { "name": "rules[].parameters.dismiss_stale_reviews_on_push", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals.", @@ -61265,7 +61588,7 @@ }, { "name": "rules[].parameters.max_file_path_length", - "description": "The maximum amount of characters allowed in file paths", + "description": "The maximum amount of characters allowed in file paths.", "in": "BODY", "type": "integer", "required": true, @@ -70945,7 +71268,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, will only return open pull requests associated with the commit.\n\nTo list the open or merged pull requests associated with a branch, you can set the `commit_sha` parameter to the branch name.", + "description": "Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, it will return merged and open pull requests associated with the commit.\n\nTo list the open or merged pull requests associated with a branch, you can set the `commit_sha` parameter to the branch name.", "documentationUrl": "https://docs.github.com/rest/commits/commits#list-pull-requests-associated-with-a-commit", "previews": [], "headers": [], @@ -72026,7 +72349,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Removes a collaborator from a repository.\n\nTo use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal.\n\nThis endpoint also:\n- Cancels any outstanding invitations\n- Unasigns the user from any issues\n- Removes access to organization projects if the user is not an organization member and is not a collaborator on any other organization repositories.\n- Unstars the repository\n- Updates access permissions to packages\n\nRemoving a user as a collaborator has the following effects on forks:\n - If the user had access to a fork through their membership to this repository, the user will also be removed from the fork.\n - If the user had their own fork of the repository, the fork will be deleted.\n - If the user still has read access to the repository, open pull requests by this user from a fork will be denied.\n\n> [!NOTE]\n> A user can still have access to the repository through organization permissions like base repository permissions.\n\nAlthough the API responds immediately, the additional permission updates might take some extra time to complete in the background.\n\nFor more information on fork permissions, see \"[About permissions and visibility of forks](https://docs.github.com/pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks)\".", + "description": "Removes a collaborator from a repository.\n\nTo use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal.\n\nThis endpoint also:\n- Cancels any outstanding invitations sent by the collaborator\n- Unassigns the user from any issues\n- Removes access to organization projects if the user is not an organization member and is not a collaborator on any other organization repositories.\n- Unstars the repository\n- Updates access permissions to packages\n\nRemoving a user as a collaborator has the following effects on forks:\n - If the user had access to a fork through their membership to this repository, the user will also be removed from the fork.\n - If the user had their own fork of the repository, the fork will be deleted.\n - If the user still has read access to the repository, open pull requests by this user from a fork will be denied.\n\n> [!NOTE]\n> A user can still have access to the repository through organization permissions like base repository permissions.\n\nAlthough the API responds immediately, the additional permission updates might take some extra time to complete in the background.\n\nFor more information on fork permissions, see \"[About permissions and visibility of forks](https://docs.github.com/pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks)\".", "documentationUrl": "https://docs.github.com/rest/collaborators/collaborators#remove-a-repository-collaborator", "previews": [], "headers": [], @@ -73308,6 +73631,32 @@ "alias": null, "deprecated": null }, + { + "name": "security_and_analysis.code_security", + "description": "Use the `status` property to enable or disable GitHub Code Security for this repository.", + "in": "BODY", + "type": "object", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "security_and_analysis.code_security.status", + "description": "Can be `enabled` or `disabled`.", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, { "name": "security_and_analysis.secret_scanning", "description": "Use the `status` property to enable or disable secret scanning for this repository. For more information, see \"[About secret scanning](/code-security/secret-security/about-secret-scanning).\"", @@ -74837,6 +75186,19 @@ "alias": null, "deprecated": null }, + { + "name": "rules[].parameters.automatic_copilot_code_review_enabled", + "description": "Automatically request review from Copilot for new pull requests, if the author has access to Copilot code review.", + "in": "BODY", + "type": "boolean", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, { "name": "rules[].parameters.dismiss_stale_reviews_on_push", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals.", @@ -75034,7 +75396,7 @@ }, { "name": "rules[].parameters.max_file_path_length", - "description": "The maximum amount of characters allowed in file paths", + "description": "The maximum amount of characters allowed in file paths.", "in": "BODY", "type": "integer", "required": true, @@ -76091,6 +76453,19 @@ "alias": null, "deprecated": null }, + { + "name": "rules[].parameters.automatic_copilot_code_review_enabled", + "description": "Automatically request review from Copilot for new pull requests, if the author has access to Copilot code review.", + "in": "BODY", + "type": "boolean", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, { "name": "rules[].parameters.dismiss_stale_reviews_on_push", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals.", @@ -76288,7 +76663,7 @@ }, { "name": "rules[].parameters.max_file_path_length", - "description": "The maximum amount of characters allowed in file paths", + "description": "The maximum amount of characters allowed in file paths.", "in": "BODY", "type": "integer", "required": true, diff --git a/src/generated/endpoints.ts b/src/generated/endpoints.ts index 2d7053db..59206e6a 100644 --- a/src/generated/endpoints.ts +++ b/src/generated/endpoints.ts @@ -481,6 +481,13 @@ const Endpoints: EndpointsDefaultsAndDecorations = { "GET /users/{username}/settings/billing/shared-storage", ], }, + campaigns: { + createCampaign: ["POST /orgs/{org}/campaigns"], + deleteCampaign: ["DELETE /orgs/{org}/campaigns/{campaign_number}"], + getCampaignSummary: ["GET /orgs/{org}/campaigns/{campaign_number}"], + listOrgCampaigns: ["GET /orgs/{org}/campaigns"], + updateCampaign: ["PATCH /orgs/{org}/campaigns/{campaign_number}"], + }, checks: { create: ["POST /repos/{owner}/{repo}/check-runs"], createSuite: ["POST /repos/{owner}/{repo}/check-suites"], @@ -760,8 +767,6 @@ const Endpoints: EndpointsDefaultsAndDecorations = { "GET /orgs/{org}/members/{username}/copilot", ], listCopilotSeats: ["GET /orgs/{org}/copilot/billing/seats"], - usageMetricsForOrg: ["GET /orgs/{org}/copilot/usage"], - usageMetricsForTeam: ["GET /orgs/{org}/team/{team_slug}/copilot/usage"], }, dependabot: { addSelectedRepoToOrgSecret: [ @@ -1305,208 +1310,6 @@ const Endpoints: EndpointsDefaultsAndDecorations = { "PATCH /orgs/{org}/private-registries/{secret_name}", ], }, - projects: { - addCollaborator: [ - "PUT /projects/{project_id}/collaborators/{username}", - {}, - { - deprecated: - "octokit.rest.projects.addCollaborator() is deprecated, see https://docs.github.com/rest/projects/collaborators#add-project-collaborator", - }, - ], - createCard: [ - "POST /projects/columns/{column_id}/cards", - {}, - { - deprecated: - "octokit.rest.projects.createCard() is deprecated, see https://docs.github.com/rest/projects/cards#create-a-project-card", - }, - ], - createColumn: [ - "POST /projects/{project_id}/columns", - {}, - { - deprecated: - "octokit.rest.projects.createColumn() is deprecated, see https://docs.github.com/rest/projects/columns#create-a-project-column", - }, - ], - createForAuthenticatedUser: [ - "POST /user/projects", - {}, - { - deprecated: - "octokit.rest.projects.createForAuthenticatedUser() is deprecated, see https://docs.github.com/rest/projects/projects#create-a-user-project", - }, - ], - createForOrg: [ - "POST /orgs/{org}/projects", - {}, - { - deprecated: - "octokit.rest.projects.createForOrg() is deprecated, see https://docs.github.com/rest/projects/projects#create-an-organization-project", - }, - ], - createForRepo: [ - "POST /repos/{owner}/{repo}/projects", - {}, - { - deprecated: - "octokit.rest.projects.createForRepo() is deprecated, see https://docs.github.com/rest/projects/projects#create-a-repository-project", - }, - ], - delete: [ - "DELETE /projects/{project_id}", - {}, - { - deprecated: - "octokit.rest.projects.delete() is deprecated, see https://docs.github.com/rest/projects/projects#delete-a-project", - }, - ], - deleteCard: [ - "DELETE /projects/columns/cards/{card_id}", - {}, - { - deprecated: - "octokit.rest.projects.deleteCard() is deprecated, see https://docs.github.com/rest/projects/cards#delete-a-project-card", - }, - ], - deleteColumn: [ - "DELETE /projects/columns/{column_id}", - {}, - { - deprecated: - "octokit.rest.projects.deleteColumn() is deprecated, see https://docs.github.com/rest/projects/columns#delete-a-project-column", - }, - ], - get: [ - "GET /projects/{project_id}", - {}, - { - deprecated: - "octokit.rest.projects.get() is deprecated, see https://docs.github.com/rest/projects/projects#get-a-project", - }, - ], - getCard: [ - "GET /projects/columns/cards/{card_id}", - {}, - { - deprecated: - "octokit.rest.projects.getCard() is deprecated, see https://docs.github.com/rest/projects/cards#get-a-project-card", - }, - ], - getColumn: [ - "GET /projects/columns/{column_id}", - {}, - { - deprecated: - "octokit.rest.projects.getColumn() is deprecated, see https://docs.github.com/rest/projects/columns#get-a-project-column", - }, - ], - getPermissionForUser: [ - "GET /projects/{project_id}/collaborators/{username}/permission", - {}, - { - deprecated: - "octokit.rest.projects.getPermissionForUser() is deprecated, see https://docs.github.com/rest/projects/collaborators#get-project-permission-for-a-user", - }, - ], - listCards: [ - "GET /projects/columns/{column_id}/cards", - {}, - { - deprecated: - "octokit.rest.projects.listCards() is deprecated, see https://docs.github.com/rest/projects/cards#list-project-cards", - }, - ], - listCollaborators: [ - "GET /projects/{project_id}/collaborators", - {}, - { - deprecated: - "octokit.rest.projects.listCollaborators() is deprecated, see https://docs.github.com/rest/projects/collaborators#list-project-collaborators", - }, - ], - listColumns: [ - "GET /projects/{project_id}/columns", - {}, - { - deprecated: - "octokit.rest.projects.listColumns() is deprecated, see https://docs.github.com/rest/projects/columns#list-project-columns", - }, - ], - listForOrg: [ - "GET /orgs/{org}/projects", - {}, - { - deprecated: - "octokit.rest.projects.listForOrg() is deprecated, see https://docs.github.com/rest/projects/projects#list-organization-projects", - }, - ], - listForRepo: [ - "GET /repos/{owner}/{repo}/projects", - {}, - { - deprecated: - "octokit.rest.projects.listForRepo() is deprecated, see https://docs.github.com/rest/projects/projects#list-repository-projects", - }, - ], - listForUser: [ - "GET /users/{username}/projects", - {}, - { - deprecated: - "octokit.rest.projects.listForUser() is deprecated, see https://docs.github.com/rest/projects/projects#list-user-projects", - }, - ], - moveCard: [ - "POST /projects/columns/cards/{card_id}/moves", - {}, - { - deprecated: - "octokit.rest.projects.moveCard() is deprecated, see https://docs.github.com/rest/projects/cards#move-a-project-card", - }, - ], - moveColumn: [ - "POST /projects/columns/{column_id}/moves", - {}, - { - deprecated: - "octokit.rest.projects.moveColumn() is deprecated, see https://docs.github.com/rest/projects/columns#move-a-project-column", - }, - ], - removeCollaborator: [ - "DELETE /projects/{project_id}/collaborators/{username}", - {}, - { - deprecated: - "octokit.rest.projects.removeCollaborator() is deprecated, see https://docs.github.com/rest/projects/collaborators#remove-user-as-a-collaborator", - }, - ], - update: [ - "PATCH /projects/{project_id}", - {}, - { - deprecated: - "octokit.rest.projects.update() is deprecated, see https://docs.github.com/rest/projects/projects#update-a-project", - }, - ], - updateCard: [ - "PATCH /projects/columns/cards/{card_id}", - {}, - { - deprecated: - "octokit.rest.projects.updateCard() is deprecated, see https://docs.github.com/rest/projects/cards#update-an-existing-project-card", - }, - ], - updateColumn: [ - "PATCH /projects/columns/{column_id}", - {}, - { - deprecated: - "octokit.rest.projects.updateColumn() is deprecated, see https://docs.github.com/rest/projects/columns#update-an-existing-project-column", - }, - ], - }, pulls: { checkIfMerged: ["GET /repos/{owner}/{repo}/pulls/{pull_number}/merge"], create: ["POST /repos/{owner}/{repo}/pulls"], @@ -2118,41 +1921,9 @@ const Endpoints: EndpointsDefaultsAndDecorations = { addOrUpdateMembershipForUserInOrg: [ "PUT /orgs/{org}/teams/{team_slug}/memberships/{username}", ], - addOrUpdateProjectPermissionsInOrg: [ - "PUT /orgs/{org}/teams/{team_slug}/projects/{project_id}", - {}, - { - deprecated: - "octokit.rest.teams.addOrUpdateProjectPermissionsInOrg() is deprecated, see https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions", - }, - ], - addOrUpdateProjectPermissionsLegacy: [ - "PUT /teams/{team_id}/projects/{project_id}", - {}, - { - deprecated: - "octokit.rest.teams.addOrUpdateProjectPermissionsLegacy() is deprecated, see https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions-legacy", - }, - ], addOrUpdateRepoPermissionsInOrg: [ "PUT /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", ], - checkPermissionsForProjectInOrg: [ - "GET /orgs/{org}/teams/{team_slug}/projects/{project_id}", - {}, - { - deprecated: - "octokit.rest.teams.checkPermissionsForProjectInOrg() is deprecated, see https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project", - }, - ], - checkPermissionsForProjectLegacy: [ - "GET /teams/{team_id}/projects/{project_id}", - {}, - { - deprecated: - "octokit.rest.teams.checkPermissionsForProjectLegacy() is deprecated, see https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project-legacy", - }, - ], checkPermissionsForRepoInOrg: [ "GET /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", ], @@ -2189,42 +1960,10 @@ const Endpoints: EndpointsDefaultsAndDecorations = { listPendingInvitationsInOrg: [ "GET /orgs/{org}/teams/{team_slug}/invitations", ], - listProjectsInOrg: [ - "GET /orgs/{org}/teams/{team_slug}/projects", - {}, - { - deprecated: - "octokit.rest.teams.listProjectsInOrg() is deprecated, see https://docs.github.com/rest/teams/teams#list-team-projects", - }, - ], - listProjectsLegacy: [ - "GET /teams/{team_id}/projects", - {}, - { - deprecated: - "octokit.rest.teams.listProjectsLegacy() is deprecated, see https://docs.github.com/rest/teams/teams#list-team-projects-legacy", - }, - ], listReposInOrg: ["GET /orgs/{org}/teams/{team_slug}/repos"], removeMembershipForUserInOrg: [ "DELETE /orgs/{org}/teams/{team_slug}/memberships/{username}", ], - removeProjectInOrg: [ - "DELETE /orgs/{org}/teams/{team_slug}/projects/{project_id}", - {}, - { - deprecated: - "octokit.rest.teams.removeProjectInOrg() is deprecated, see https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team", - }, - ], - removeProjectLegacy: [ - "DELETE /teams/{team_id}/projects/{project_id}", - {}, - { - deprecated: - "octokit.rest.teams.removeProjectLegacy() is deprecated, see https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team-legacy", - }, - ], removeRepoInOrg: [ "DELETE /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", ], diff --git a/src/generated/method-types.ts b/src/generated/method-types.ts index bbb0b121..4291adc2 100644 --- a/src/generated/method-types.ts +++ b/src/generated/method-types.ts @@ -3314,6 +3314,91 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; }; + campaigns: { + /** + * Create a campaign for an organization. + * + * The authenticated user must be an owner or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. + * + * Fine-grained tokens must have the "Code scanning alerts" repository permissions (read) on all repositories included + * in the campaign. + */ + createCampaign: { + ( + params?: RestEndpointMethodTypes["campaigns"]["createCampaign"]["parameters"], + ): Promise< + RestEndpointMethodTypes["campaigns"]["createCampaign"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Deletes a campaign in an organization. + * + * The authenticated user must be an owner or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. + */ + deleteCampaign: { + ( + params?: RestEndpointMethodTypes["campaigns"]["deleteCampaign"]["parameters"], + ): Promise< + RestEndpointMethodTypes["campaigns"]["deleteCampaign"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Gets a campaign for an organization. + * + * The authenticated user must be an owner or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. + */ + getCampaignSummary: { + ( + params?: RestEndpointMethodTypes["campaigns"]["getCampaignSummary"]["parameters"], + ): Promise< + RestEndpointMethodTypes["campaigns"]["getCampaignSummary"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Lists campaigns in an organization. + * + * The authenticated user must be an owner or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. + */ + listOrgCampaigns: { + ( + params?: RestEndpointMethodTypes["campaigns"]["listOrgCampaigns"]["parameters"], + ): Promise< + RestEndpointMethodTypes["campaigns"]["listOrgCampaigns"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Updates a campaign in an organization. + * + * The authenticated user must be an owner or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. + */ + updateCampaign: { + ( + params?: RestEndpointMethodTypes["campaigns"]["updateCampaign"]["parameters"], + ): Promise< + RestEndpointMethodTypes["campaigns"]["updateCampaign"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + }; checks: { /** * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. @@ -5186,59 +5271,6 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; - /** - * > [!NOTE] - * > This endpoint is closing down. It will be accessible throughout February 2025, but will not return any new data after February 1st. - * - * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE - * across an organization, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. - * See the response schema tab for detailed metrics definitions. - * - * The response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day, - * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, - * they must have telemetry enabled in their IDE. - * - * Organization owners, and owners and billing managers of the parent enterprise, can view Copilot usage metrics. - * - * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. - */ - usageMetricsForOrg: { - ( - params?: RestEndpointMethodTypes["copilot"]["usageMetricsForOrg"]["parameters"], - ): Promise< - RestEndpointMethodTypes["copilot"]["usageMetricsForOrg"]["response"] - >; - defaults: RequestInterface["defaults"]; - endpoint: EndpointInterface<{ url: string }>; - }; - /** - * > [!NOTE] - * > This endpoint is closing down. It will be accessible throughout February 2025, but will not return any new data after February 1st. - * - * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE - * for users within a team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. - * See the response schema tab for detailed metrics definitions. - * - * The response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day, - * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, - * they must have telemetry enabled in their IDE. - * - * > [!NOTE] - * > This endpoint will only return results for a given day if the team had five or more members with active Copilot licenses, as evaluated at the end of that day. - * - * Organization owners for the organization that contains this team, and owners and billing managers of the parent enterprise can view Copilot usage metrics for a team. - * - * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. - */ - usageMetricsForTeam: { - ( - params?: RestEndpointMethodTypes["copilot"]["usageMetricsForTeam"]["parameters"], - ): Promise< - RestEndpointMethodTypes["copilot"]["usageMetricsForTeam"]["response"] - >; - defaults: RequestInterface["defaults"]; - endpoint: EndpointInterface<{ url: string }>; - }; }; dependabot: { /** @@ -7555,6 +7587,9 @@ export type RestEndpointMethods = { * Create a new issue type for an organization. * * You can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization). + * + * To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and + * personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ createIssueType: { ( @@ -7657,6 +7692,9 @@ export type RestEndpointMethods = { * Deletes an issue type for an organization. * * You can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization). + * + * To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and + * personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ deleteIssueType: { ( @@ -7986,7 +8024,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Lists all issue types for an organization. + * Lists all issue types for an organization. OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint. */ listIssueTypes: { ( @@ -8497,6 +8535,9 @@ export type RestEndpointMethods = { * Updates an issue type for an organization. * * You can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization). + * + * To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and + * personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ updateIssueType: { ( @@ -9141,359 +9182,6 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; }; - projects: { - /** - * > [!WARNING] - * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - * @deprecated octokit.rest.projects.addCollaborator() is deprecated, see https://docs.github.com/rest/projects/collaborators#add-project-collaborator - */ - addCollaborator: { - ( - params?: RestEndpointMethodTypes["projects"]["addCollaborator"]["parameters"], - ): Promise< - RestEndpointMethodTypes["projects"]["addCollaborator"]["response"] - >; - defaults: RequestInterface["defaults"]; - endpoint: EndpointInterface<{ url: string }>; - }; - /** - * > [!WARNING] - * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - * @deprecated octokit.rest.projects.createCard() is deprecated, see https://docs.github.com/rest/projects/cards#create-a-project-card - */ - createCard: { - ( - params?: RestEndpointMethodTypes["projects"]["createCard"]["parameters"], - ): Promise; - defaults: RequestInterface["defaults"]; - endpoint: EndpointInterface<{ url: string }>; - }; - /** - * > [!WARNING] - * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - * @deprecated octokit.rest.projects.createColumn() is deprecated, see https://docs.github.com/rest/projects/columns#create-a-project-column - */ - createColumn: { - ( - params?: RestEndpointMethodTypes["projects"]["createColumn"]["parameters"], - ): Promise< - RestEndpointMethodTypes["projects"]["createColumn"]["response"] - >; - defaults: RequestInterface["defaults"]; - endpoint: EndpointInterface<{ url: string }>; - }; - /** - * > [!WARNING] - * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - * @deprecated octokit.rest.projects.createForAuthenticatedUser() is deprecated, see https://docs.github.com/rest/projects/projects#create-a-user-project - */ - createForAuthenticatedUser: { - ( - params?: RestEndpointMethodTypes["projects"]["createForAuthenticatedUser"]["parameters"], - ): Promise< - RestEndpointMethodTypes["projects"]["createForAuthenticatedUser"]["response"] - >; - defaults: RequestInterface["defaults"]; - endpoint: EndpointInterface<{ url: string }>; - }; - /** - * > [!WARNING] - * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - * @deprecated octokit.rest.projects.createForOrg() is deprecated, see https://docs.github.com/rest/projects/projects#create-an-organization-project - */ - createForOrg: { - ( - params?: RestEndpointMethodTypes["projects"]["createForOrg"]["parameters"], - ): Promise< - RestEndpointMethodTypes["projects"]["createForOrg"]["response"] - >; - defaults: RequestInterface["defaults"]; - endpoint: EndpointInterface<{ url: string }>; - }; - /** - * > [!WARNING] - * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - * @deprecated octokit.rest.projects.createForRepo() is deprecated, see https://docs.github.com/rest/projects/projects#create-a-repository-project - */ - createForRepo: { - ( - params?: RestEndpointMethodTypes["projects"]["createForRepo"]["parameters"], - ): Promise< - RestEndpointMethodTypes["projects"]["createForRepo"]["response"] - >; - defaults: RequestInterface["defaults"]; - endpoint: EndpointInterface<{ url: string }>; - }; - /** - * > [!WARNING] - * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - * @deprecated octokit.rest.projects.delete() is deprecated, see https://docs.github.com/rest/projects/projects#delete-a-project - */ - delete: { - ( - params?: RestEndpointMethodTypes["projects"]["delete"]["parameters"], - ): Promise; - defaults: RequestInterface["defaults"]; - endpoint: EndpointInterface<{ url: string }>; - }; - /** - * > [!WARNING] - * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - * @deprecated octokit.rest.projects.deleteCard() is deprecated, see https://docs.github.com/rest/projects/cards#delete-a-project-card - */ - deleteCard: { - ( - params?: RestEndpointMethodTypes["projects"]["deleteCard"]["parameters"], - ): Promise; - defaults: RequestInterface["defaults"]; - endpoint: EndpointInterface<{ url: string }>; - }; - /** - * > [!WARNING] - * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - * @deprecated octokit.rest.projects.deleteColumn() is deprecated, see https://docs.github.com/rest/projects/columns#delete-a-project-column - */ - deleteColumn: { - ( - params?: RestEndpointMethodTypes["projects"]["deleteColumn"]["parameters"], - ): Promise< - RestEndpointMethodTypes["projects"]["deleteColumn"]["response"] - >; - defaults: RequestInterface["defaults"]; - endpoint: EndpointInterface<{ url: string }>; - }; - /** - * > [!WARNING] - * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - * @deprecated octokit.rest.projects.get() is deprecated, see https://docs.github.com/rest/projects/projects#get-a-project - */ - get: { - ( - params?: RestEndpointMethodTypes["projects"]["get"]["parameters"], - ): Promise; - defaults: RequestInterface["defaults"]; - endpoint: EndpointInterface<{ url: string }>; - }; - /** - * > [!WARNING] - * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - * @deprecated octokit.rest.projects.getCard() is deprecated, see https://docs.github.com/rest/projects/cards#get-a-project-card - */ - getCard: { - ( - params?: RestEndpointMethodTypes["projects"]["getCard"]["parameters"], - ): Promise; - defaults: RequestInterface["defaults"]; - endpoint: EndpointInterface<{ url: string }>; - }; - /** - * > [!WARNING] - * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - * @deprecated octokit.rest.projects.getColumn() is deprecated, see https://docs.github.com/rest/projects/columns#get-a-project-column - */ - getColumn: { - ( - params?: RestEndpointMethodTypes["projects"]["getColumn"]["parameters"], - ): Promise; - defaults: RequestInterface["defaults"]; - endpoint: EndpointInterface<{ url: string }>; - }; - /** - * > [!WARNING] - * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - * @deprecated octokit.rest.projects.getPermissionForUser() is deprecated, see https://docs.github.com/rest/projects/collaborators#get-project-permission-for-a-user - */ - getPermissionForUser: { - ( - params?: RestEndpointMethodTypes["projects"]["getPermissionForUser"]["parameters"], - ): Promise< - RestEndpointMethodTypes["projects"]["getPermissionForUser"]["response"] - >; - defaults: RequestInterface["defaults"]; - endpoint: EndpointInterface<{ url: string }>; - }; - /** - * > [!WARNING] - * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - * @deprecated octokit.rest.projects.listCards() is deprecated, see https://docs.github.com/rest/projects/cards#list-project-cards - */ - listCards: { - ( - params?: RestEndpointMethodTypes["projects"]["listCards"]["parameters"], - ): Promise; - defaults: RequestInterface["defaults"]; - endpoint: EndpointInterface<{ url: string }>; - }; - /** - * > [!WARNING] - * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - * @deprecated octokit.rest.projects.listCollaborators() is deprecated, see https://docs.github.com/rest/projects/collaborators#list-project-collaborators - */ - listCollaborators: { - ( - params?: RestEndpointMethodTypes["projects"]["listCollaborators"]["parameters"], - ): Promise< - RestEndpointMethodTypes["projects"]["listCollaborators"]["response"] - >; - defaults: RequestInterface["defaults"]; - endpoint: EndpointInterface<{ url: string }>; - }; - /** - * > [!WARNING] - * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - * @deprecated octokit.rest.projects.listColumns() is deprecated, see https://docs.github.com/rest/projects/columns#list-project-columns - */ - listColumns: { - ( - params?: RestEndpointMethodTypes["projects"]["listColumns"]["parameters"], - ): Promise< - RestEndpointMethodTypes["projects"]["listColumns"]["response"] - >; - defaults: RequestInterface["defaults"]; - endpoint: EndpointInterface<{ url: string }>; - }; - /** - * > [!WARNING] - * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - * @deprecated octokit.rest.projects.listForOrg() is deprecated, see https://docs.github.com/rest/projects/projects#list-organization-projects - */ - listForOrg: { - ( - params?: RestEndpointMethodTypes["projects"]["listForOrg"]["parameters"], - ): Promise; - defaults: RequestInterface["defaults"]; - endpoint: EndpointInterface<{ url: string }>; - }; - /** - * > [!WARNING] - * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - * @deprecated octokit.rest.projects.listForRepo() is deprecated, see https://docs.github.com/rest/projects/projects#list-repository-projects - */ - listForRepo: { - ( - params?: RestEndpointMethodTypes["projects"]["listForRepo"]["parameters"], - ): Promise< - RestEndpointMethodTypes["projects"]["listForRepo"]["response"] - >; - defaults: RequestInterface["defaults"]; - endpoint: EndpointInterface<{ url: string }>; - }; - /** - * > [!WARNING] - * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - * @deprecated octokit.rest.projects.listForUser() is deprecated, see https://docs.github.com/rest/projects/projects#list-user-projects - */ - listForUser: { - ( - params?: RestEndpointMethodTypes["projects"]["listForUser"]["parameters"], - ): Promise< - RestEndpointMethodTypes["projects"]["listForUser"]["response"] - >; - defaults: RequestInterface["defaults"]; - endpoint: EndpointInterface<{ url: string }>; - }; - /** - * > [!WARNING] - * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - * @deprecated octokit.rest.projects.moveCard() is deprecated, see https://docs.github.com/rest/projects/cards#move-a-project-card - */ - moveCard: { - ( - params?: RestEndpointMethodTypes["projects"]["moveCard"]["parameters"], - ): Promise; - defaults: RequestInterface["defaults"]; - endpoint: EndpointInterface<{ url: string }>; - }; - /** - * > [!WARNING] - * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - * @deprecated octokit.rest.projects.moveColumn() is deprecated, see https://docs.github.com/rest/projects/columns#move-a-project-column - */ - moveColumn: { - ( - params?: RestEndpointMethodTypes["projects"]["moveColumn"]["parameters"], - ): Promise; - defaults: RequestInterface["defaults"]; - endpoint: EndpointInterface<{ url: string }>; - }; - /** - * > [!WARNING] - * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - * @deprecated octokit.rest.projects.removeCollaborator() is deprecated, see https://docs.github.com/rest/projects/collaborators#remove-user-as-a-collaborator - */ - removeCollaborator: { - ( - params?: RestEndpointMethodTypes["projects"]["removeCollaborator"]["parameters"], - ): Promise< - RestEndpointMethodTypes["projects"]["removeCollaborator"]["response"] - >; - defaults: RequestInterface["defaults"]; - endpoint: EndpointInterface<{ url: string }>; - }; - /** - * > [!WARNING] - * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - * @deprecated octokit.rest.projects.update() is deprecated, see https://docs.github.com/rest/projects/projects#update-a-project - */ - update: { - ( - params?: RestEndpointMethodTypes["projects"]["update"]["parameters"], - ): Promise; - defaults: RequestInterface["defaults"]; - endpoint: EndpointInterface<{ url: string }>; - }; - /** - * > [!WARNING] - * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - * @deprecated octokit.rest.projects.updateCard() is deprecated, see https://docs.github.com/rest/projects/cards#update-an-existing-project-card - */ - updateCard: { - ( - params?: RestEndpointMethodTypes["projects"]["updateCard"]["parameters"], - ): Promise; - defaults: RequestInterface["defaults"]; - endpoint: EndpointInterface<{ url: string }>; - }; - /** - * > [!WARNING] - * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - * @deprecated octokit.rest.projects.updateColumn() is deprecated, see https://docs.github.com/rest/projects/columns#update-an-existing-project-column - */ - updateColumn: { - ( - params?: RestEndpointMethodTypes["projects"]["updateColumn"]["parameters"], - ): Promise< - RestEndpointMethodTypes["projects"]["updateColumn"]["response"] - >; - defaults: RequestInterface["defaults"]; - endpoint: EndpointInterface<{ url: string }>; - }; - }; pulls: { /** * Checks if a pull request has been merged into the base branch. The HTTP status of the response indicates whether or not the pull request has been merged; the response body is empty. @@ -12753,7 +12441,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, will only return open pull requests associated with the commit. + * Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, it will return merged and open pull requests associated with the commit. * * To list the open or merged pull requests associated with a branch, you can set the `commit_sha` parameter to the branch name. */ @@ -12892,8 +12580,8 @@ export type RestEndpointMethods = { * To use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal. * * This endpoint also: - * - Cancels any outstanding invitations - * - Unasigns the user from any issues + * - Cancels any outstanding invitations sent by the collaborator + * - Unassigns the user from any issues * - Removes access to organization projects if the user is not an organization member and is not a collaborator on any other organization repositories. * - Unstars the repository * - Updates access permissions to packages @@ -13799,36 +13487,6 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; - /** - * > [!WARNING] - * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - * @deprecated octokit.rest.teams.addOrUpdateProjectPermissionsInOrg() is deprecated, see https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions - */ - addOrUpdateProjectPermissionsInOrg: { - ( - params?: RestEndpointMethodTypes["teams"]["addOrUpdateProjectPermissionsInOrg"]["parameters"], - ): Promise< - RestEndpointMethodTypes["teams"]["addOrUpdateProjectPermissionsInOrg"]["response"] - >; - defaults: RequestInterface["defaults"]; - endpoint: EndpointInterface<{ url: string }>; - }; - /** - * > [!WARNING] - * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - * @deprecated octokit.rest.teams.addOrUpdateProjectPermissionsLegacy() is deprecated, see https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions-legacy - */ - addOrUpdateProjectPermissionsLegacy: { - ( - params?: RestEndpointMethodTypes["teams"]["addOrUpdateProjectPermissionsLegacy"]["parameters"], - ): Promise< - RestEndpointMethodTypes["teams"]["addOrUpdateProjectPermissionsLegacy"]["response"] - >; - defaults: RequestInterface["defaults"]; - endpoint: EndpointInterface<{ url: string }>; - }; /** * 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 method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." * @@ -13846,36 +13504,6 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; - /** - * > [!WARNING] - * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - * @deprecated octokit.rest.teams.checkPermissionsForProjectInOrg() is deprecated, see https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project - */ - checkPermissionsForProjectInOrg: { - ( - params?: RestEndpointMethodTypes["teams"]["checkPermissionsForProjectInOrg"]["parameters"], - ): Promise< - RestEndpointMethodTypes["teams"]["checkPermissionsForProjectInOrg"]["response"] - >; - defaults: RequestInterface["defaults"]; - endpoint: EndpointInterface<{ url: string }>; - }; - /** - * > [!WARNING] - * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - * @deprecated octokit.rest.teams.checkPermissionsForProjectLegacy() is deprecated, see https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project-legacy - */ - checkPermissionsForProjectLegacy: { - ( - params?: RestEndpointMethodTypes["teams"]["checkPermissionsForProjectLegacy"]["parameters"], - ): Promise< - RestEndpointMethodTypes["teams"]["checkPermissionsForProjectLegacy"]["response"] - >; - defaults: RequestInterface["defaults"]; - endpoint: EndpointInterface<{ url: string }>; - }; /** * Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked. * @@ -14170,36 +13798,6 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; - /** - * > [!WARNING] - * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - * @deprecated octokit.rest.teams.listProjectsInOrg() is deprecated, see https://docs.github.com/rest/teams/teams#list-team-projects - */ - listProjectsInOrg: { - ( - params?: RestEndpointMethodTypes["teams"]["listProjectsInOrg"]["parameters"], - ): Promise< - RestEndpointMethodTypes["teams"]["listProjectsInOrg"]["response"] - >; - defaults: RequestInterface["defaults"]; - endpoint: EndpointInterface<{ url: string }>; - }; - /** - * > [!WARNING] - * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - * @deprecated octokit.rest.teams.listProjectsLegacy() is deprecated, see https://docs.github.com/rest/teams/teams#list-team-projects-legacy - */ - listProjectsLegacy: { - ( - params?: RestEndpointMethodTypes["teams"]["listProjectsLegacy"]["parameters"], - ): Promise< - RestEndpointMethodTypes["teams"]["listProjectsLegacy"]["response"] - >; - defaults: RequestInterface["defaults"]; - endpoint: EndpointInterface<{ url: string }>; - }; /** * Lists a team's repositories visible to the authenticated user. * @@ -14235,36 +13833,6 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; - /** - * > [!WARNING] - * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - * @deprecated octokit.rest.teams.removeProjectInOrg() is deprecated, see https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team - */ - removeProjectInOrg: { - ( - params?: RestEndpointMethodTypes["teams"]["removeProjectInOrg"]["parameters"], - ): Promise< - RestEndpointMethodTypes["teams"]["removeProjectInOrg"]["response"] - >; - defaults: RequestInterface["defaults"]; - endpoint: EndpointInterface<{ url: string }>; - }; - /** - * > [!WARNING] - * > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - * > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - * @deprecated octokit.rest.teams.removeProjectLegacy() is deprecated, see https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team-legacy - */ - removeProjectLegacy: { - ( - params?: RestEndpointMethodTypes["teams"]["removeProjectLegacy"]["parameters"], - ): Promise< - RestEndpointMethodTypes["teams"]["removeProjectLegacy"]["response"] - >; - defaults: RequestInterface["defaults"]; - endpoint: EndpointInterface<{ url: string }>; - }; /** * 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. * diff --git a/src/generated/parameters-and-response-types.ts b/src/generated/parameters-and-response-types.ts index 9164b9bf..5118f41a 100644 --- a/src/generated/parameters-and-response-types.ts +++ b/src/generated/parameters-and-response-types.ts @@ -1081,6 +1081,33 @@ export type RestEndpointMethodTypes = { response: Endpoints["GET /users/{username}/settings/billing/shared-storage"]["response"]; }; }; + campaigns: { + createCampaign: { + parameters: RequestParameters & + Endpoints["POST /orgs/{org}/campaigns"]["parameters"]; + response: Endpoints["POST /orgs/{org}/campaigns"]["response"]; + }; + deleteCampaign: { + parameters: RequestParameters & + Endpoints["DELETE /orgs/{org}/campaigns/{campaign_number}"]["parameters"]; + response: Endpoints["DELETE /orgs/{org}/campaigns/{campaign_number}"]["response"]; + }; + getCampaignSummary: { + parameters: RequestParameters & + Endpoints["GET /orgs/{org}/campaigns/{campaign_number}"]["parameters"]; + response: Endpoints["GET /orgs/{org}/campaigns/{campaign_number}"]["response"]; + }; + listOrgCampaigns: { + parameters: RequestParameters & + Endpoints["GET /orgs/{org}/campaigns"]["parameters"]; + response: Endpoints["GET /orgs/{org}/campaigns"]["response"]; + }; + updateCampaign: { + parameters: RequestParameters & + Endpoints["PATCH /orgs/{org}/campaigns/{campaign_number}"]["parameters"]; + response: Endpoints["PATCH /orgs/{org}/campaigns/{campaign_number}"]["response"]; + }; + }; checks: { create: { parameters: RequestParameters & @@ -1642,16 +1669,6 @@ export type RestEndpointMethodTypes = { Endpoints["GET /orgs/{org}/copilot/billing/seats"]["parameters"]; response: Endpoints["GET /orgs/{org}/copilot/billing/seats"]["response"]; }; - usageMetricsForOrg: { - parameters: RequestParameters & - Endpoints["GET /orgs/{org}/copilot/usage"]["parameters"]; - response: Endpoints["GET /orgs/{org}/copilot/usage"]["response"]; - }; - usageMetricsForTeam: { - parameters: RequestParameters & - Endpoints["GET /orgs/{org}/team/{team_slug}/copilot/usage"]["parameters"]; - response: Endpoints["GET /orgs/{org}/team/{team_slug}/copilot/usage"]["response"]; - }; }; dependabot: { addSelectedRepoToOrgSecret: { @@ -2985,133 +3002,6 @@ export type RestEndpointMethodTypes = { response: Endpoints["PATCH /orgs/{org}/private-registries/{secret_name}"]["response"]; }; }; - projects: { - addCollaborator: { - parameters: RequestParameters & - Endpoints["PUT /projects/{project_id}/collaborators/{username}"]["parameters"]; - response: Endpoints["PUT /projects/{project_id}/collaborators/{username}"]["response"]; - }; - createCard: { - parameters: RequestParameters & - Endpoints["POST /projects/columns/{column_id}/cards"]["parameters"]; - response: Endpoints["POST /projects/columns/{column_id}/cards"]["response"]; - }; - createColumn: { - parameters: RequestParameters & - Endpoints["POST /projects/{project_id}/columns"]["parameters"]; - response: Endpoints["POST /projects/{project_id}/columns"]["response"]; - }; - createForAuthenticatedUser: { - parameters: RequestParameters & - Endpoints["POST /user/projects"]["parameters"]; - response: Endpoints["POST /user/projects"]["response"]; - }; - createForOrg: { - parameters: RequestParameters & - Endpoints["POST /orgs/{org}/projects"]["parameters"]; - response: Endpoints["POST /orgs/{org}/projects"]["response"]; - }; - createForRepo: { - parameters: RequestParameters & - Endpoints["POST /repos/{owner}/{repo}/projects"]["parameters"]; - response: Endpoints["POST /repos/{owner}/{repo}/projects"]["response"]; - }; - delete: { - parameters: RequestParameters & - Endpoints["DELETE /projects/{project_id}"]["parameters"]; - response: Endpoints["DELETE /projects/{project_id}"]["response"]; - }; - deleteCard: { - parameters: RequestParameters & - Endpoints["DELETE /projects/columns/cards/{card_id}"]["parameters"]; - response: Endpoints["DELETE /projects/columns/cards/{card_id}"]["response"]; - }; - deleteColumn: { - parameters: RequestParameters & - Endpoints["DELETE /projects/columns/{column_id}"]["parameters"]; - response: Endpoints["DELETE /projects/columns/{column_id}"]["response"]; - }; - get: { - parameters: RequestParameters & - Endpoints["GET /projects/{project_id}"]["parameters"]; - response: Endpoints["GET /projects/{project_id}"]["response"]; - }; - getCard: { - parameters: RequestParameters & - Endpoints["GET /projects/columns/cards/{card_id}"]["parameters"]; - response: Endpoints["GET /projects/columns/cards/{card_id}"]["response"]; - }; - getColumn: { - parameters: RequestParameters & - Endpoints["GET /projects/columns/{column_id}"]["parameters"]; - response: Endpoints["GET /projects/columns/{column_id}"]["response"]; - }; - getPermissionForUser: { - parameters: RequestParameters & - Endpoints["GET /projects/{project_id}/collaborators/{username}/permission"]["parameters"]; - response: Endpoints["GET /projects/{project_id}/collaborators/{username}/permission"]["response"]; - }; - listCards: { - parameters: RequestParameters & - Endpoints["GET /projects/columns/{column_id}/cards"]["parameters"]; - response: Endpoints["GET /projects/columns/{column_id}/cards"]["response"]; - }; - listCollaborators: { - parameters: RequestParameters & - Endpoints["GET /projects/{project_id}/collaborators"]["parameters"]; - response: Endpoints["GET /projects/{project_id}/collaborators"]["response"]; - }; - listColumns: { - parameters: RequestParameters & - Endpoints["GET /projects/{project_id}/columns"]["parameters"]; - response: Endpoints["GET /projects/{project_id}/columns"]["response"]; - }; - listForOrg: { - parameters: RequestParameters & - Endpoints["GET /orgs/{org}/projects"]["parameters"]; - response: Endpoints["GET /orgs/{org}/projects"]["response"]; - }; - listForRepo: { - parameters: RequestParameters & - Endpoints["GET /repos/{owner}/{repo}/projects"]["parameters"]; - response: Endpoints["GET /repos/{owner}/{repo}/projects"]["response"]; - }; - listForUser: { - parameters: RequestParameters & - Endpoints["GET /users/{username}/projects"]["parameters"]; - response: Endpoints["GET /users/{username}/projects"]["response"]; - }; - moveCard: { - parameters: RequestParameters & - Endpoints["POST /projects/columns/cards/{card_id}/moves"]["parameters"]; - response: Endpoints["POST /projects/columns/cards/{card_id}/moves"]["response"]; - }; - moveColumn: { - parameters: RequestParameters & - Endpoints["POST /projects/columns/{column_id}/moves"]["parameters"]; - response: Endpoints["POST /projects/columns/{column_id}/moves"]["response"]; - }; - removeCollaborator: { - parameters: RequestParameters & - Endpoints["DELETE /projects/{project_id}/collaborators/{username}"]["parameters"]; - response: Endpoints["DELETE /projects/{project_id}/collaborators/{username}"]["response"]; - }; - update: { - parameters: RequestParameters & - Endpoints["PATCH /projects/{project_id}"]["parameters"]; - response: Endpoints["PATCH /projects/{project_id}"]["response"]; - }; - updateCard: { - parameters: RequestParameters & - Endpoints["PATCH /projects/columns/cards/{card_id}"]["parameters"]; - response: Endpoints["PATCH /projects/columns/cards/{card_id}"]["response"]; - }; - updateColumn: { - parameters: RequestParameters & - Endpoints["PATCH /projects/columns/{column_id}"]["parameters"]; - response: Endpoints["PATCH /projects/columns/{column_id}"]["response"]; - }; - }; pulls: { checkIfMerged: { parameters: RequestParameters & @@ -4517,31 +4407,11 @@ export type RestEndpointMethodTypes = { Endpoints["PUT /orgs/{org}/teams/{team_slug}/memberships/{username}"]["parameters"]; response: Endpoints["PUT /orgs/{org}/teams/{team_slug}/memberships/{username}"]["response"]; }; - addOrUpdateProjectPermissionsInOrg: { - parameters: RequestParameters & - Endpoints["PUT /orgs/{org}/teams/{team_slug}/projects/{project_id}"]["parameters"]; - response: Endpoints["PUT /orgs/{org}/teams/{team_slug}/projects/{project_id}"]["response"]; - }; - addOrUpdateProjectPermissionsLegacy: { - parameters: RequestParameters & - Endpoints["PUT /teams/{team_id}/projects/{project_id}"]["parameters"]; - response: Endpoints["PUT /teams/{team_id}/projects/{project_id}"]["response"]; - }; addOrUpdateRepoPermissionsInOrg: { parameters: RequestParameters & Endpoints["PUT /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}"]["parameters"]; response: Endpoints["PUT /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}"]["response"]; }; - checkPermissionsForProjectInOrg: { - parameters: RequestParameters & - Endpoints["GET /orgs/{org}/teams/{team_slug}/projects/{project_id}"]["parameters"]; - response: Endpoints["GET /orgs/{org}/teams/{team_slug}/projects/{project_id}"]["response"]; - }; - checkPermissionsForProjectLegacy: { - parameters: RequestParameters & - Endpoints["GET /teams/{team_id}/projects/{project_id}"]["parameters"]; - response: Endpoints["GET /teams/{team_id}/projects/{project_id}"]["response"]; - }; checkPermissionsForRepoInOrg: { parameters: RequestParameters & Endpoints["GET /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}"]["parameters"]; @@ -4632,16 +4502,6 @@ export type RestEndpointMethodTypes = { Endpoints["GET /orgs/{org}/teams/{team_slug}/invitations"]["parameters"]; response: Endpoints["GET /orgs/{org}/teams/{team_slug}/invitations"]["response"]; }; - listProjectsInOrg: { - parameters: RequestParameters & - Endpoints["GET /orgs/{org}/teams/{team_slug}/projects"]["parameters"]; - response: Endpoints["GET /orgs/{org}/teams/{team_slug}/projects"]["response"]; - }; - listProjectsLegacy: { - parameters: RequestParameters & - Endpoints["GET /teams/{team_id}/projects"]["parameters"]; - response: Endpoints["GET /teams/{team_id}/projects"]["response"]; - }; listReposInOrg: { parameters: RequestParameters & Endpoints["GET /orgs/{org}/teams/{team_slug}/repos"]["parameters"]; @@ -4652,16 +4512,6 @@ export type RestEndpointMethodTypes = { Endpoints["DELETE /orgs/{org}/teams/{team_slug}/memberships/{username}"]["parameters"]; response: Endpoints["DELETE /orgs/{org}/teams/{team_slug}/memberships/{username}"]["response"]; }; - removeProjectInOrg: { - parameters: RequestParameters & - Endpoints["DELETE /orgs/{org}/teams/{team_slug}/projects/{project_id}"]["parameters"]; - response: Endpoints["DELETE /orgs/{org}/teams/{team_slug}/projects/{project_id}"]["response"]; - }; - removeProjectLegacy: { - parameters: RequestParameters & - Endpoints["DELETE /teams/{team_id}/projects/{project_id}"]["parameters"]; - response: Endpoints["DELETE /teams/{team_id}/projects/{project_id}"]["response"]; - }; removeRepoInOrg: { parameters: RequestParameters & Endpoints["DELETE /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}"]["parameters"];