aws-delivlib 14.4.2 → 14.4.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/publishing/github/node_modules/.yarn-integrity +42 -36
- package/lib/publishing/github/node_modules/@octokit/app/dist-node/index.js +146 -106
- package/lib/publishing/github/node_modules/@octokit/app/dist-node/index.js.map +7 -1
- package/lib/publishing/github/node_modules/@octokit/app/dist-src/each-installation.js +34 -23
- package/lib/publishing/github/node_modules/@octokit/app/dist-src/each-repository.js +46 -38
- package/lib/publishing/github/node_modules/@octokit/app/dist-src/get-installation-octokit.js +16 -13
- package/lib/publishing/github/node_modules/@octokit/app/dist-src/index.js +76 -63
- package/lib/publishing/github/node_modules/@octokit/app/dist-src/middleware/node/index.js +48 -41
- package/lib/publishing/github/node_modules/@octokit/app/dist-src/middleware/node/on-unhandled-request-default.js +12 -7
- package/lib/publishing/github/node_modules/@octokit/app/dist-src/version.js +4 -1
- package/lib/publishing/github/node_modules/@octokit/app/dist-src/webhooks.js +44 -51
- package/lib/publishing/github/node_modules/@octokit/app/dist-types/each-installation.d.ts +6 -3
- package/lib/publishing/github/node_modules/@octokit/app/dist-types/each-repository.d.ts +1 -0
- package/lib/publishing/github/node_modules/@octokit/app/dist-types/version.d.ts +1 -1
- package/lib/publishing/github/node_modules/@octokit/app/dist-web/index.js +306 -0
- package/lib/publishing/github/node_modules/@octokit/app/dist-web/index.js.map +7 -0
- package/lib/publishing/github/node_modules/@octokit/app/package.json +22 -21
- package/lib/publishing/github/node_modules/@octokit/auth-app/dist-node/index.js +239 -180
- package/lib/publishing/github/node_modules/@octokit/auth-app/dist-node/index.js.map +7 -1
- package/lib/publishing/github/node_modules/@octokit/auth-app/dist-src/auth.js +27 -24
- package/lib/publishing/github/node_modules/@octokit/auth-app/dist-src/cache.js +73 -66
- package/lib/publishing/github/node_modules/@octokit/auth-app/dist-src/get-app-authentication.js +28 -21
- package/lib/publishing/github/node_modules/@octokit/auth-app/dist-src/get-installation-authentication.js +96 -74
- package/lib/publishing/github/node_modules/@octokit/auth-app/dist-src/hook.js +79 -75
- package/lib/publishing/github/node_modules/@octokit/auth-app/dist-src/index.js +51 -39
- package/lib/publishing/github/node_modules/@octokit/auth-app/dist-src/requires-app-auth.js +30 -47
- package/lib/publishing/github/node_modules/@octokit/auth-app/dist-src/to-token-authentication.js +29 -11
- package/lib/publishing/github/node_modules/@octokit/auth-app/dist-src/version.js +4 -1
- package/lib/publishing/github/node_modules/@octokit/auth-app/dist-types/auth.d.ts +1 -1
- package/lib/publishing/github/node_modules/@octokit/auth-app/dist-types/cache.d.ts +3 -3
- package/lib/publishing/github/node_modules/@octokit/auth-app/dist-types/get-app-authentication.d.ts +1 -1
- package/lib/publishing/github/node_modules/@octokit/auth-app/dist-types/get-installation-authentication.d.ts +1 -1
- package/lib/publishing/github/node_modules/@octokit/auth-app/dist-types/hook.d.ts +1 -1
- package/lib/publishing/github/node_modules/@octokit/auth-app/dist-types/index.d.ts +2 -2
- package/lib/publishing/github/node_modules/@octokit/auth-app/dist-types/to-token-authentication.d.ts +1 -1
- package/lib/publishing/github/node_modules/@octokit/auth-app/dist-types/types.d.ts +1 -1
- package/lib/publishing/github/node_modules/@octokit/auth-app/dist-types/version.d.ts +1 -1
- package/lib/publishing/github/node_modules/@octokit/auth-app/dist-web/index.js +405 -360
- package/lib/publishing/github/node_modules/@octokit/auth-app/dist-web/index.js.map +7 -1
- package/lib/publishing/github/node_modules/@octokit/auth-app/package.json +24 -25
- package/lib/publishing/github/node_modules/@octokit/auth-oauth-app/dist-node/index.js +15 -17
- package/lib/publishing/github/node_modules/@octokit/auth-oauth-app/dist-node/index.js.map +1 -1
- package/lib/publishing/github/node_modules/@octokit/auth-oauth-app/dist-src/version.js +1 -1
- package/lib/publishing/github/node_modules/@octokit/auth-oauth-app/dist-types/types.d.ts +17 -17
- package/lib/publishing/github/node_modules/@octokit/auth-oauth-app/dist-types/version.d.ts +1 -1
- package/lib/publishing/github/node_modules/@octokit/auth-oauth-app/dist-web/index.js +1 -1
- package/lib/publishing/github/node_modules/@octokit/auth-oauth-app/dist-web/index.js.map +1 -1
- package/lib/publishing/github/node_modules/@octokit/auth-oauth-app/package.json +3 -3
- package/lib/publishing/github/node_modules/@octokit/auth-oauth-device/dist-node/index.js +23 -31
- package/lib/publishing/github/node_modules/@octokit/auth-oauth-device/dist-node/index.js.map +1 -1
- package/lib/publishing/github/node_modules/@octokit/auth-oauth-device/dist-src/version.js +1 -1
- package/lib/publishing/github/node_modules/@octokit/auth-oauth-device/dist-types/types.d.ts +12 -12
- package/lib/publishing/github/node_modules/@octokit/auth-oauth-device/dist-types/version.d.ts +1 -1
- package/lib/publishing/github/node_modules/@octokit/auth-oauth-device/dist-web/index.js +1 -1
- package/lib/publishing/github/node_modules/@octokit/auth-oauth-device/dist-web/index.js.map +1 -1
- package/lib/publishing/github/node_modules/@octokit/auth-oauth-device/package.json +5 -5
- package/lib/publishing/github/node_modules/@octokit/auth-oauth-user/README.md +23 -1
- package/lib/publishing/github/node_modules/@octokit/auth-oauth-user/dist-node/index.js +40 -39
- package/lib/publishing/github/node_modules/@octokit/auth-oauth-user/dist-node/index.js.map +1 -1
- package/lib/publishing/github/node_modules/@octokit/auth-oauth-user/dist-src/auth.js +8 -0
- package/lib/publishing/github/node_modules/@octokit/auth-oauth-user/dist-src/get-authentication.js +3 -0
- package/lib/publishing/github/node_modules/@octokit/auth-oauth-user/dist-src/index.js +2 -1
- package/lib/publishing/github/node_modules/@octokit/auth-oauth-user/dist-src/version.js +1 -1
- package/lib/publishing/github/node_modules/@octokit/auth-oauth-user/dist-types/hook.d.ts +1 -1
- package/lib/publishing/github/node_modules/@octokit/auth-oauth-user/dist-types/types.d.ts +38 -34
- package/lib/publishing/github/node_modules/@octokit/auth-oauth-user/dist-types/version.d.ts +1 -1
- package/lib/publishing/github/node_modules/@octokit/auth-oauth-user/dist-web/index.js +14 -2
- package/lib/publishing/github/node_modules/@octokit/auth-oauth-user/dist-web/index.js.map +1 -1
- package/lib/publishing/github/node_modules/@octokit/auth-oauth-user/package.json +5 -5
- package/lib/publishing/github/node_modules/@octokit/auth-token/README.md +5 -10
- package/lib/publishing/github/node_modules/@octokit/auth-token/dist-node/index.js +44 -20
- package/lib/publishing/github/node_modules/@octokit/auth-token/dist-node/index.js.map +7 -1
- package/lib/publishing/github/node_modules/@octokit/auth-token/dist-src/auth.js +13 -17
- package/lib/publishing/github/node_modules/@octokit/auth-token/dist-src/hook.js +10 -4
- package/lib/publishing/github/node_modules/@octokit/auth-token/dist-src/index.js +16 -11
- package/lib/publishing/github/node_modules/@octokit/auth-token/dist-src/with-authorization-prefix.js +8 -10
- package/lib/publishing/github/node_modules/@octokit/auth-token/dist-types/auth.d.ts +1 -1
- package/lib/publishing/github/node_modules/@octokit/auth-token/dist-types/hook.d.ts +1 -1
- package/lib/publishing/github/node_modules/@octokit/auth-token/dist-types/index.d.ts +2 -2
- package/lib/publishing/github/node_modules/@octokit/auth-token/dist-types/types.d.ts +13 -13
- package/lib/publishing/github/node_modules/@octokit/auth-token/dist-web/index.js +42 -45
- package/lib/publishing/github/node_modules/@octokit/auth-token/dist-web/index.js.map +7 -1
- package/lib/publishing/github/node_modules/@octokit/auth-token/package.json +23 -27
- package/lib/publishing/github/node_modules/@octokit/auth-unauthenticated/dist-node/index.js +47 -22
- package/lib/publishing/github/node_modules/@octokit/auth-unauthenticated/dist-node/index.js.map +7 -1
- package/lib/publishing/github/node_modules/@octokit/auth-unauthenticated/dist-src/auth.js +8 -5
- package/lib/publishing/github/node_modules/@octokit/auth-unauthenticated/dist-src/hook.js +33 -24
- package/lib/publishing/github/node_modules/@octokit/auth-unauthenticated/dist-src/index.js +12 -7
- package/lib/publishing/github/node_modules/@octokit/auth-unauthenticated/dist-src/is-abuse-limit-error.js +8 -5
- package/lib/publishing/github/node_modules/@octokit/auth-unauthenticated/dist-src/is-rate-limit-error.js +11 -9
- package/lib/publishing/github/node_modules/@octokit/auth-unauthenticated/dist-types/index.d.ts +1 -1
- package/lib/publishing/github/node_modules/@octokit/auth-unauthenticated/dist-types/types.d.ts +9 -9
- package/lib/publishing/github/node_modules/@octokit/auth-unauthenticated/dist-web/index.js +62 -50
- package/lib/publishing/github/node_modules/@octokit/auth-unauthenticated/dist-web/index.js.map +7 -1
- package/lib/publishing/github/node_modules/@octokit/auth-unauthenticated/package.json +22 -23
- package/lib/publishing/github/node_modules/@octokit/core/README.md +4 -4
- package/lib/publishing/github/node_modules/@octokit/core/dist-node/index.js +119 -100
- package/lib/publishing/github/node_modules/@octokit/core/dist-node/index.js.map +7 -1
- package/lib/publishing/github/node_modules/@octokit/core/dist-src/index.js +114 -112
- package/lib/publishing/github/node_modules/@octokit/core/dist-src/version.js +4 -1
- package/lib/publishing/github/node_modules/@octokit/core/dist-types/types.d.ts +7 -7
- package/lib/publishing/github/node_modules/@octokit/core/dist-types/version.d.ts +1 -1
- package/lib/publishing/github/node_modules/@octokit/core/dist-web/index.js +124 -122
- package/lib/publishing/github/node_modules/@octokit/core/dist-web/index.js.map +7 -1
- package/lib/publishing/github/node_modules/@octokit/core/package.json +26 -27
- package/lib/publishing/github/node_modules/@octokit/endpoint/README.md +3 -3
- package/lib/publishing/github/node_modules/@octokit/endpoint/dist-node/index.js +22 -62
- package/lib/publishing/github/node_modules/@octokit/endpoint/dist-node/index.js.map +1 -1
- package/lib/publishing/github/node_modules/@octokit/endpoint/dist-src/version.js +1 -1
- package/lib/publishing/github/node_modules/@octokit/endpoint/dist-types/version.d.ts +1 -1
- package/lib/publishing/github/node_modules/@octokit/endpoint/dist-web/index.js +1 -1
- package/lib/publishing/github/node_modules/@octokit/endpoint/dist-web/index.js.map +1 -1
- package/lib/publishing/github/node_modules/@octokit/endpoint/package.json +4 -4
- package/lib/publishing/github/node_modules/@octokit/graphql/README.md +1 -1
- package/lib/publishing/github/node_modules/@octokit/graphql/dist-node/index.js +81 -39
- package/lib/publishing/github/node_modules/@octokit/graphql/dist-node/index.js.map +7 -1
- package/lib/publishing/github/node_modules/@octokit/graphql/dist-src/error.js +17 -17
- package/lib/publishing/github/node_modules/@octokit/graphql/dist-src/graphql.js +55 -44
- package/lib/publishing/github/node_modules/@octokit/graphql/dist-src/index.js +17 -12
- package/lib/publishing/github/node_modules/@octokit/graphql/dist-src/version.js +4 -1
- package/lib/publishing/github/node_modules/@octokit/graphql/dist-src/with-defaults.js +12 -9
- package/lib/publishing/github/node_modules/@octokit/graphql/dist-types/error.d.ts +3 -3
- package/lib/publishing/github/node_modules/@octokit/graphql/dist-types/graphql.d.ts +1 -1
- package/lib/publishing/github/node_modules/@octokit/graphql/dist-types/index.d.ts +1 -1
- package/lib/publishing/github/node_modules/@octokit/graphql/dist-types/types.d.ts +7 -7
- package/lib/publishing/github/node_modules/@octokit/graphql/dist-types/version.d.ts +1 -1
- package/lib/publishing/github/node_modules/@octokit/graphql/dist-types/with-defaults.d.ts +1 -1
- package/lib/publishing/github/node_modules/@octokit/graphql/dist-web/index.js +103 -90
- package/lib/publishing/github/node_modules/@octokit/graphql/dist-web/index.js.map +7 -1
- package/lib/publishing/github/node_modules/@octokit/graphql/package.json +23 -24
- package/lib/publishing/github/node_modules/@octokit/oauth-app/dist-node/index.js +290 -263
- package/lib/publishing/github/node_modules/@octokit/oauth-app/dist-node/index.js.map +7 -1
- package/lib/publishing/github/node_modules/@octokit/oauth-app/dist-src/add-event-handler.js +13 -10
- package/lib/publishing/github/node_modules/@octokit/oauth-app/dist-src/emit-event.js +13 -10
- package/lib/publishing/github/node_modules/@octokit/oauth-app/dist-src/index.js +108 -64
- package/lib/publishing/github/node_modules/@octokit/oauth-app/dist-src/methods/check-token.js +14 -11
- package/lib/publishing/github/node_modules/@octokit/oauth-app/dist-src/methods/create-token.js +27 -24
- package/lib/publishing/github/node_modules/@octokit/oauth-app/dist-src/methods/delete-authorization.js +43 -40
- package/lib/publishing/github/node_modules/@octokit/oauth-app/dist-src/methods/delete-token.js +32 -29
- package/lib/publishing/github/node_modules/@octokit/oauth-app/dist-src/methods/get-oauth-client-code.js +5 -2
- package/lib/publishing/github/node_modules/@octokit/oauth-app/dist-src/methods/get-user-octokit.js +29 -24
- package/lib/publishing/github/node_modules/@octokit/oauth-app/dist-src/methods/get-web-flow-authorization-url.js +16 -28
- package/lib/publishing/github/node_modules/@octokit/oauth-app/dist-src/methods/refresh-token.js +34 -29
- package/lib/publishing/github/node_modules/@octokit/oauth-app/dist-src/methods/reset-token.js +58 -55
- package/lib/publishing/github/node_modules/@octokit/oauth-app/dist-src/methods/scope-token.js +34 -29
- package/lib/publishing/github/node_modules/@octokit/oauth-app/dist-src/middleware/aws-lambda/api-gateway-v2-parse-request.js +14 -11
- package/lib/publishing/github/node_modules/@octokit/oauth-app/dist-src/middleware/aws-lambda/api-gateway-v2-send-response.js +9 -6
- package/lib/publishing/github/node_modules/@octokit/oauth-app/dist-src/middleware/aws-lambda/api-gateway-v2.js +21 -13
- package/lib/publishing/github/node_modules/@octokit/oauth-app/dist-src/middleware/handle-request.js +217 -210
- package/lib/publishing/github/node_modules/@octokit/oauth-app/dist-src/middleware/node/index.js +30 -20
- package/lib/publishing/github/node_modules/@octokit/oauth-app/dist-src/middleware/node/parse-request.js +13 -13
- package/lib/publishing/github/node_modules/@octokit/oauth-app/dist-src/middleware/node/send-response.js +6 -3
- package/lib/publishing/github/node_modules/@octokit/oauth-app/dist-src/middleware/on-unhandled-request-default.js +11 -8
- package/lib/publishing/github/node_modules/@octokit/oauth-app/dist-src/middleware/web-worker/index.js +31 -19
- package/lib/publishing/github/node_modules/@octokit/oauth-app/dist-src/middleware/web-worker/parse-request.js +11 -9
- package/lib/publishing/github/node_modules/@octokit/oauth-app/dist-src/middleware/web-worker/send-response.js +8 -5
- package/lib/publishing/github/node_modules/@octokit/oauth-app/dist-src/oauth-app-octokit.js +5 -2
- package/lib/publishing/github/node_modules/@octokit/oauth-app/dist-src/version.js +4 -1
- package/lib/publishing/github/node_modules/@octokit/oauth-app/dist-types/middleware/web-worker/index.d.ts +1 -1
- package/lib/publishing/github/node_modules/@octokit/oauth-app/dist-types/version.d.ts +1 -1
- package/lib/publishing/github/node_modules/@octokit/oauth-app/package.json +20 -20
- package/lib/publishing/github/node_modules/@octokit/oauth-methods/dist-node/index.js +1 -1
- package/lib/publishing/github/node_modules/@octokit/oauth-methods/dist-node/index.js.map +1 -1
- package/lib/publishing/github/node_modules/@octokit/oauth-methods/dist-src/version.js +1 -1
- package/lib/publishing/github/node_modules/@octokit/oauth-methods/dist-types/check-token.d.ts +4 -4
- package/lib/publishing/github/node_modules/@octokit/oauth-methods/dist-types/create-device-code.d.ts +3 -3
- package/lib/publishing/github/node_modules/@octokit/oauth-methods/dist-types/delete-authorization.d.ts +3 -3
- package/lib/publishing/github/node_modules/@octokit/oauth-methods/dist-types/delete-token.d.ts +3 -3
- package/lib/publishing/github/node_modules/@octokit/oauth-methods/dist-types/exchange-device-code.d.ts +11 -11
- package/lib/publishing/github/node_modules/@octokit/oauth-methods/dist-types/exchange-web-flow-code.d.ts +4 -4
- package/lib/publishing/github/node_modules/@octokit/oauth-methods/dist-types/get-web-flow-authorization-url.d.ts +4 -4
- package/lib/publishing/github/node_modules/@octokit/oauth-methods/dist-types/refresh-token.d.ts +2 -2
- package/lib/publishing/github/node_modules/@octokit/oauth-methods/dist-types/reset-token.d.ts +4 -4
- package/lib/publishing/github/node_modules/@octokit/oauth-methods/dist-types/scope-token.d.ts +8 -8
- package/lib/publishing/github/node_modules/@octokit/oauth-methods/dist-types/types.d.ts +9 -9
- package/lib/publishing/github/node_modules/@octokit/oauth-methods/dist-types/version.d.ts +1 -1
- package/lib/publishing/github/node_modules/@octokit/oauth-methods/package.json +7 -7
- package/lib/publishing/github/node_modules/@octokit/openapi-types/package.json +2 -2
- package/lib/publishing/github/node_modules/@octokit/openapi-types/types.d.ts +77450 -13127
- package/lib/publishing/github/node_modules/@octokit/plugin-paginate-rest/dist-node/index.js +292 -57
- package/lib/publishing/github/node_modules/@octokit/plugin-paginate-rest/dist-node/index.js.map +7 -1
- package/lib/publishing/github/node_modules/@octokit/plugin-paginate-rest/dist-src/compose-paginate.js +5 -2
- package/lib/publishing/github/node_modules/@octokit/plugin-paginate-rest/dist-src/generated/paginating-endpoints.js +226 -213
- package/lib/publishing/github/node_modules/@octokit/plugin-paginate-rest/dist-src/index.js +17 -12
- package/lib/publishing/github/node_modules/@octokit/plugin-paginate-rest/dist-src/iterator.js +36 -37
- package/lib/publishing/github/node_modules/@octokit/plugin-paginate-rest/dist-src/normalize-paginated-list-response.js +29 -45
- package/lib/publishing/github/node_modules/@octokit/plugin-paginate-rest/dist-src/paginate.js +31 -21
- package/lib/publishing/github/node_modules/@octokit/plugin-paginate-rest/dist-src/paginating-endpoints.js +14 -9
- package/lib/publishing/github/node_modules/@octokit/plugin-paginate-rest/dist-src/version.js +4 -1
- package/lib/publishing/github/node_modules/@octokit/plugin-paginate-rest/dist-types/compose-paginate.d.ts +1 -1
- package/lib/publishing/github/node_modules/@octokit/plugin-paginate-rest/dist-types/generated/paginating-endpoints.d.ts +183 -111
- package/lib/publishing/github/node_modules/@octokit/plugin-paginate-rest/dist-types/index.d.ts +3 -4
- package/lib/publishing/github/node_modules/@octokit/plugin-paginate-rest/dist-types/iterator.d.ts +3 -3
- package/lib/publishing/github/node_modules/@octokit/plugin-paginate-rest/dist-types/normalize-paginated-list-response.d.ts +1 -1
- package/lib/publishing/github/node_modules/@octokit/plugin-paginate-rest/dist-types/paginate.d.ts +3 -3
- package/lib/publishing/github/node_modules/@octokit/plugin-paginate-rest/dist-types/types.d.ts +29 -29
- package/lib/publishing/github/node_modules/@octokit/plugin-paginate-rest/dist-types/version.d.ts +1 -1
- package/lib/publishing/github/node_modules/@octokit/plugin-paginate-rest/dist-web/index.js +334 -334
- package/lib/publishing/github/node_modules/@octokit/plugin-paginate-rest/dist-web/index.js.map +7 -1
- package/lib/publishing/github/node_modules/@octokit/plugin-paginate-rest/package.json +24 -26
- package/lib/publishing/github/node_modules/@octokit/plugin-rest-endpoint-methods/dist-node/index.js +99 -39
- package/lib/publishing/github/node_modules/@octokit/plugin-rest-endpoint-methods/dist-node/index.js.map +1 -1
- package/lib/publishing/github/node_modules/@octokit/plugin-rest-endpoint-methods/dist-src/generated/endpoints.js +197 -77
- package/lib/publishing/github/node_modules/@octokit/plugin-rest-endpoint-methods/dist-src/version.js +1 -1
- package/lib/publishing/github/node_modules/@octokit/plugin-rest-endpoint-methods/dist-types/generated/method-types.d.ts +1419 -661
- package/lib/publishing/github/node_modules/@octokit/plugin-rest-endpoint-methods/dist-types/generated/parameters-and-response-types.d.ts +359 -119
- package/lib/publishing/github/node_modules/@octokit/plugin-rest-endpoint-methods/dist-types/types.d.ts +3 -3
- package/lib/publishing/github/node_modules/@octokit/plugin-rest-endpoint-methods/dist-types/version.d.ts +1 -1
- package/lib/publishing/github/node_modules/@octokit/plugin-rest-endpoint-methods/dist-web/index.js +198 -78
- package/lib/publishing/github/node_modules/@octokit/plugin-rest-endpoint-methods/dist-web/index.js.map +1 -1
- package/lib/publishing/github/node_modules/@octokit/plugin-rest-endpoint-methods/package.json +9 -9
- package/lib/publishing/github/node_modules/@octokit/plugin-retry/dist-node/index.js +80 -35
- package/lib/publishing/github/node_modules/@octokit/plugin-retry/dist-node/index.js.map +7 -1
- package/lib/publishing/github/node_modules/@octokit/plugin-retry/dist-src/error-request.js +12 -13
- package/lib/publishing/github/node_modules/@octokit/plugin-retry/dist-src/index.js +29 -22
- package/lib/publishing/github/node_modules/@octokit/plugin-retry/dist-src/version.js +4 -1
- package/lib/publishing/github/node_modules/@octokit/plugin-retry/dist-src/wrap-request.js +31 -15
- package/lib/publishing/github/node_modules/@octokit/plugin-retry/dist-types/error-request.d.ts +1 -1
- package/lib/publishing/github/node_modules/@octokit/plugin-retry/dist-types/version.d.ts +1 -1
- package/lib/publishing/github/node_modules/@octokit/plugin-retry/dist-types/wrap-request.d.ts +1 -1
- package/lib/publishing/github/node_modules/@octokit/plugin-retry/dist-web/index.js +68 -54
- package/lib/publishing/github/node_modules/@octokit/plugin-retry/dist-web/index.js.map +7 -1
- package/lib/publishing/github/node_modules/@octokit/plugin-retry/package.json +21 -22
- package/lib/publishing/github/node_modules/@octokit/plugin-throttling/dist-node/index.js +18 -11
- package/lib/publishing/github/node_modules/@octokit/plugin-throttling/dist-node/index.js.map +1 -1
- package/lib/publishing/github/node_modules/@octokit/plugin-throttling/dist-src/index.js +21 -14
- package/lib/publishing/github/node_modules/@octokit/plugin-throttling/dist-src/version.js +1 -1
- package/lib/publishing/github/node_modules/@octokit/plugin-throttling/dist-types/index.d.ts +6 -0
- package/lib/publishing/github/node_modules/@octokit/plugin-throttling/dist-types/types.d.ts +13 -12
- package/lib/publishing/github/node_modules/@octokit/plugin-throttling/dist-types/version.d.ts +1 -1
- package/lib/publishing/github/node_modules/@octokit/plugin-throttling/dist-web/index.js +22 -15
- package/lib/publishing/github/node_modules/@octokit/plugin-throttling/dist-web/index.js.map +1 -1
- package/lib/publishing/github/node_modules/@octokit/plugin-throttling/package.json +7 -7
- package/lib/publishing/github/node_modules/@octokit/request/README.md +3 -3
- package/lib/publishing/github/node_modules/@octokit/request/dist-node/index.js +105 -77
- package/lib/publishing/github/node_modules/@octokit/request/dist-node/index.js.map +7 -1
- package/lib/publishing/github/node_modules/@octokit/request/dist-src/fetch-wrapper.js +111 -108
- package/lib/publishing/github/node_modules/@octokit/request/dist-src/get-buffer-response.js +5 -2
- package/lib/publishing/github/node_modules/@octokit/request/dist-src/index.js +7 -4
- package/lib/publishing/github/node_modules/@octokit/request/dist-src/version.js +4 -1
- package/lib/publishing/github/node_modules/@octokit/request/dist-src/with-defaults.js +23 -18
- package/lib/publishing/github/node_modules/@octokit/request/dist-types/version.d.ts +1 -1
- package/lib/publishing/github/node_modules/@octokit/request/dist-web/index.js +148 -138
- package/lib/publishing/github/node_modules/@octokit/request/dist-web/index.js.map +7 -1
- package/lib/publishing/github/node_modules/@octokit/request/package.json +23 -24
- package/lib/publishing/github/node_modules/@octokit/request-error/dist-node/index.js +10 -19
- package/lib/publishing/github/node_modules/@octokit/request-error/dist-node/index.js.map +1 -1
- package/lib/publishing/github/node_modules/@octokit/request-error/dist-types/types.d.ts +1 -1
- package/lib/publishing/github/node_modules/@octokit/request-error/package.json +4 -4
- package/lib/publishing/github/node_modules/@octokit/tsconfig/LICENSE +7 -0
- package/lib/publishing/github/node_modules/@octokit/tsconfig/README.md +31 -0
- package/lib/publishing/github/node_modules/@octokit/tsconfig/package.json +28 -0
- package/lib/publishing/github/node_modules/@octokit/types/dist-node/index.js +1 -1
- package/lib/publishing/github/node_modules/@octokit/types/dist-src/VERSION.js +1 -1
- package/lib/publishing/github/node_modules/@octokit/types/dist-types/EndpointDefaults.d.ts +1 -1
- package/lib/publishing/github/node_modules/@octokit/types/dist-types/EndpointOptions.d.ts +1 -1
- package/lib/publishing/github/node_modules/@octokit/types/dist-types/Fetch.d.ts +1 -1
- package/lib/publishing/github/node_modules/@octokit/types/dist-types/GetResponseTypeFromEndpointMethod.d.ts +4 -4
- package/lib/publishing/github/node_modules/@octokit/types/dist-types/OctokitResponse.d.ts +1 -1
- package/lib/publishing/github/node_modules/@octokit/types/dist-types/RequestError.d.ts +1 -1
- package/lib/publishing/github/node_modules/@octokit/types/dist-types/RequestHeaders.d.ts +1 -1
- package/lib/publishing/github/node_modules/@octokit/types/dist-types/RequestMethod.d.ts +1 -1
- package/lib/publishing/github/node_modules/@octokit/types/dist-types/RequestOptions.d.ts +1 -1
- package/lib/publishing/github/node_modules/@octokit/types/dist-types/RequestParameters.d.ts +1 -1
- package/lib/publishing/github/node_modules/@octokit/types/dist-types/RequestRequestOptions.d.ts +1 -1
- package/lib/publishing/github/node_modules/@octokit/types/dist-types/ResponseHeaders.d.ts +1 -1
- package/lib/publishing/github/node_modules/@octokit/types/dist-types/Route.d.ts +1 -1
- package/lib/publishing/github/node_modules/@octokit/types/dist-types/Signal.d.ts +1 -1
- package/lib/publishing/github/node_modules/@octokit/types/dist-types/Url.d.ts +1 -1
- package/lib/publishing/github/node_modules/@octokit/types/dist-types/VERSION.d.ts +1 -1
- package/lib/publishing/github/node_modules/@octokit/types/dist-types/generated/Endpoints.d.ts +464 -332
- package/lib/publishing/github/node_modules/@octokit/types/dist-web/index.js +1 -1
- package/lib/publishing/github/node_modules/@octokit/types/package.json +10 -10
- package/lib/publishing/github/node_modules/@octokit/webhooks/README.md +68 -64
- package/lib/publishing/github/node_modules/@octokit/webhooks/dist-node/index.js +467 -97
- package/lib/publishing/github/node_modules/@octokit/webhooks/dist-node/index.js.map +7 -1
- package/lib/publishing/github/node_modules/@octokit/webhooks/dist-src/createLogger.js +11 -6
- package/lib/publishing/github/node_modules/@octokit/webhooks/dist-src/event-handler/index.js +23 -16
- package/lib/publishing/github/node_modules/@octokit/webhooks/dist-src/event-handler/on.js +31 -22
- package/lib/publishing/github/node_modules/@octokit/webhooks/dist-src/event-handler/receive.js +51 -49
- package/lib/publishing/github/node_modules/@octokit/webhooks/dist-src/event-handler/remove-listener.js +18 -15
- package/lib/publishing/github/node_modules/@octokit/webhooks/dist-src/event-handler/wrap-error-handler.js +17 -18
- package/lib/publishing/github/node_modules/@octokit/webhooks/dist-src/generated/webhook-names.js +262 -254
- package/lib/publishing/github/node_modules/@octokit/webhooks/dist-src/index.js +40 -22
- package/lib/publishing/github/node_modules/@octokit/webhooks/dist-src/middleware/node/get-missing-headers.js +8 -6
- package/lib/publishing/github/node_modules/@octokit/webhooks/dist-src/middleware/node/get-payload.js +27 -22
- package/lib/publishing/github/node_modules/@octokit/webhooks/dist-src/middleware/node/index.js +19 -6
- package/lib/publishing/github/node_modules/@octokit/webhooks/dist-src/middleware/node/middleware.js +86 -72
- package/lib/publishing/github/node_modules/@octokit/webhooks/dist-src/middleware/node/on-unhandled-request-default.js +12 -7
- package/lib/publishing/github/node_modules/@octokit/webhooks/dist-src/sign.js +8 -2
- package/lib/publishing/github/node_modules/@octokit/webhooks/dist-src/to-normalized-json-string.js +8 -8
- package/lib/publishing/github/node_modules/@octokit/webhooks/dist-src/verify-and-receive.js +22 -16
- package/lib/publishing/github/node_modules/@octokit/webhooks/dist-src/verify.js +9 -2
- package/lib/publishing/github/node_modules/@octokit/webhooks/dist-types/event-handler/on.d.ts +1 -1
- package/lib/publishing/github/node_modules/@octokit/webhooks/dist-types/event-handler/remove-listener.d.ts +1 -1
- package/lib/publishing/github/node_modules/@octokit/webhooks/dist-types/generated/webhook-names.d.ts +1 -1
- package/lib/publishing/github/node_modules/@octokit/webhooks/dist-types/index.d.ts +14 -4
- package/lib/publishing/github/node_modules/@octokit/webhooks/dist-types/middleware/node/get-missing-headers.d.ts +1 -1
- package/lib/publishing/github/node_modules/@octokit/webhooks/dist-types/middleware/node/get-payload.d.ts +3 -3
- package/lib/publishing/github/node_modules/@octokit/webhooks/dist-types/middleware/node/index.d.ts +2 -2
- package/lib/publishing/github/node_modules/@octokit/webhooks/dist-types/middleware/node/middleware.d.ts +4 -4
- package/lib/publishing/github/node_modules/@octokit/webhooks/dist-types/middleware/node/on-unhandled-request-default.d.ts +2 -2
- package/lib/publishing/github/node_modules/@octokit/webhooks/dist-types/middleware/node/types.d.ts +5 -4
- package/lib/publishing/github/node_modules/@octokit/webhooks/dist-types/to-normalized-json-string.d.ts +1 -1
- package/lib/publishing/github/node_modules/@octokit/webhooks/dist-types/types.d.ts +12 -11
- package/lib/publishing/github/node_modules/@octokit/webhooks/dist-types/verify-and-receive.d.ts +1 -1
- package/lib/publishing/github/node_modules/@octokit/webhooks/dist-web/index.js +609 -533
- package/lib/publishing/github/node_modules/@octokit/webhooks/dist-web/index.js.map +7 -1
- package/lib/publishing/github/node_modules/@octokit/webhooks/package.json +20 -22
- package/lib/publishing/github/node_modules/@octokit/webhooks-methods/README.md +84 -3
- package/lib/publishing/github/node_modules/@octokit/webhooks-methods/dist-node/index.js +89 -48
- package/lib/publishing/github/node_modules/@octokit/webhooks-methods/dist-node/index.js.map +7 -1
- package/lib/publishing/github/node_modules/@octokit/webhooks-methods/dist-src/index.js +22 -2
- package/lib/publishing/github/node_modules/@octokit/webhooks-methods/dist-src/node/sign.js +19 -16
- package/lib/publishing/github/node_modules/@octokit/webhooks-methods/dist-src/node/verify.js +18 -14
- package/lib/publishing/github/node_modules/@octokit/webhooks-methods/dist-src/types.js +8 -5
- package/lib/publishing/github/node_modules/@octokit/webhooks-methods/dist-src/utils.js +5 -2
- package/lib/publishing/github/node_modules/@octokit/webhooks-methods/dist-src/version.js +4 -1
- package/lib/publishing/github/node_modules/@octokit/webhooks-methods/dist-src/web.js +62 -44
- package/lib/publishing/github/node_modules/@octokit/webhooks-methods/dist-types/index.d.ts +3 -1
- package/lib/publishing/github/node_modules/@octokit/webhooks-methods/dist-types/node/sign.d.ts +1 -1
- package/lib/publishing/github/node_modules/@octokit/webhooks-methods/dist-types/types.d.ts +2 -2
- package/lib/publishing/github/node_modules/@octokit/webhooks-methods/dist-types/version.d.ts +1 -1
- package/lib/publishing/github/node_modules/@octokit/webhooks-methods/dist-types/web.d.ts +1 -1
- package/lib/publishing/github/node_modules/@octokit/webhooks-methods/dist-web/index.js +71 -53
- package/lib/publishing/github/node_modules/@octokit/webhooks-methods/dist-web/index.js.map +7 -1
- package/lib/publishing/github/node_modules/@octokit/webhooks-methods/package.json +36 -25
- package/lib/publishing/github/node_modules/@octokit/webhooks-types/package.json +1 -1
- package/lib/publishing/github/node_modules/@octokit/webhooks-types/schema.d.ts +670 -35
- package/lib/publishing/github/node_modules/@types/aws-lambda/README.md +2 -2
- package/lib/publishing/github/node_modules/@types/aws-lambda/index.d.ts +3 -2
- package/lib/publishing/github/node_modules/@types/aws-lambda/package.json +3 -8
- package/lib/publishing/github/node_modules/@types/aws-lambda/trigger/amplify-resolver.d.ts +38 -0
- package/lib/publishing/github/node_modules/@types/aws-lambda/trigger/api-gateway-proxy.d.ts +75 -1
- package/lib/publishing/github/node_modules/@types/aws-lambda/trigger/appsync-resolver.d.ts +4 -0
- package/lib/publishing/github/node_modules/@types/aws-lambda/trigger/codecommit.d.ts +36 -0
- package/lib/publishing/github/node_modules/@types/aws-lambda/trigger/cognito-user-pool-trigger/custom-message.d.ts +8 -4
- package/lib/publishing/github/node_modules/@types/aws-lambda/trigger/cognito-user-pool-trigger/custom-sms-sender.d.ts +49 -0
- package/lib/publishing/github/node_modules/@types/aws-lambda/trigger/cognito-user-pool-trigger/index.d.ts +1 -0
- package/lib/publishing/github/node_modules/@types/aws-lambda/trigger/dynamodb-stream.d.ts +11 -1
- package/lib/publishing/github/node_modules/@types/aws-lambda/trigger/kinesis-stream.d.ts +26 -1
- package/lib/publishing/github/node_modules/@types/aws-lambda/trigger/msk.d.ts +7 -0
- package/lib/publishing/github/node_modules/@types/aws-lambda/trigger/self-managed-kafka.d.ts +27 -0
- package/lib/publishing/github/node_modules/@types/aws-lambda/trigger/sns.d.ts +2 -2
- package/lib/publishing/github/node_modules/@types/aws-lambda/trigger/sqs.d.ts +1 -0
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/README.md +1 -1
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/index.d.ts +14 -0
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/README.md +2 -2
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/assert.d.ts +135 -75
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/async_hooks.d.ts +67 -38
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/buffer.d.ts +220 -101
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/child_process.d.ts +87 -58
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/cluster.d.ts +25 -29
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/console.d.ts +5 -5
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/crypto.d.ts +873 -249
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/dgram.d.ts +16 -16
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/diagnostics_channel.d.ts +60 -21
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/dns/promises.d.ts +52 -8
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/dns.d.ts +27 -18
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/dom-events.d.ts +126 -0
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/domain.d.ts +6 -5
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/events.d.ts +166 -93
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/fs/promises.d.ts +149 -74
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/fs.d.ts +288 -121
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/globals.d.ts +22 -13
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/http.d.ts +453 -125
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/http2.d.ts +74 -46
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/https.d.ts +103 -53
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/index.d.ts +6 -2
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/inspector.d.ts +20 -16
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/module.d.ts +6 -4
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/net.d.ts +106 -16
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/os.d.ts +36 -14
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/package.json +15 -3
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/path.d.ts +37 -26
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/perf_hooks.d.ts +96 -15
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/process.d.ts +53 -50
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/punycode.d.ts +1 -1
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/querystring.d.ts +6 -6
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/readline/promises.d.ts +145 -0
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/readline.d.ts +51 -175
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/repl.d.ts +21 -21
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/stream/consumers.d.ts +2 -14
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/stream.d.ts +983 -824
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/string_decoder.d.ts +6 -6
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/test.d.ts +1052 -0
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/timers/promises.d.ts +26 -1
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/timers.d.ts +125 -4
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/tls.d.ts +149 -50
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/trace_events.d.ts +30 -9
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/ts4.8/assert/strict.d.ts +8 -0
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/ts4.8/assert.d.ts +972 -0
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/ts4.8/async_hooks.d.ts +530 -0
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/ts4.8/buffer.d.ts +2351 -0
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/ts4.8/child_process.d.ts +1395 -0
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/ts4.8/cluster.d.ts +410 -0
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/ts4.8/console.d.ts +412 -0
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/ts4.8/constants.d.ts +18 -0
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/ts4.8/crypto.d.ts +3961 -0
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/ts4.8/dgram.d.ts +545 -0
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/ts4.8/diagnostics_channel.d.ts +191 -0
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/ts4.8/dns/promises.d.ts +414 -0
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/ts4.8/dns.d.ts +668 -0
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/ts4.8/dom-events.d.ts +126 -0
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/ts4.8/domain.d.ts +170 -0
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/ts4.8/events.d.ts +724 -0
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/ts4.8/fs/promises.d.ts +1189 -0
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/ts4.8/fs.d.ts +4043 -0
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/ts4.8/globals.d.ts +303 -0
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/ts4.8/globals.global.d.ts +1 -0
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/ts4.8/http.d.ts +1724 -0
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/ts4.8/http2.d.ts +2129 -0
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/ts4.8/https.d.ts +441 -0
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/ts4.8/index.d.ts +88 -0
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/ts4.8/inspector.d.ts +2748 -0
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/ts4.8/module.d.ts +116 -0
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/ts4.8/net.d.ts +886 -0
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/ts4.8/os.d.ts +477 -0
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/ts4.8/path.d.ts +191 -0
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/ts4.8/perf_hooks.d.ts +638 -0
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/ts4.8/process.d.ts +1485 -0
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/ts4.8/punycode.d.ts +117 -0
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/ts4.8/querystring.d.ts +131 -0
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/ts4.8/readline/promises.d.ts +145 -0
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/ts4.8/readline.d.ts +526 -0
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/ts4.8/repl.d.ts +424 -0
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/ts4.8/stream/consumers.d.ts +12 -0
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/ts4.8/stream/promises.d.ts +42 -0
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/ts4.8/stream/web.d.ts +330 -0
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/ts4.8/stream.d.ts +1392 -0
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/ts4.8/string_decoder.d.ts +67 -0
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/ts4.8/test.d.ts +1052 -0
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/ts4.8/timers/promises.d.ts +93 -0
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/ts4.8/timers.d.ts +215 -0
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/ts4.8/tls.d.ts +1119 -0
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/ts4.8/trace_events.d.ts +182 -0
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/ts4.8/tty.d.ts +205 -0
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/ts4.8/url.d.ts +901 -0
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/ts4.8/util.d.ts +2052 -0
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/ts4.8/v8.d.ts +635 -0
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/ts4.8/vm.d.ts +894 -0
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/ts4.8/wasi.d.ts +152 -0
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/ts4.8/worker_threads.d.ts +693 -0
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/ts4.8/zlib.d.ts +517 -0
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/tty.d.ts +7 -6
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/url.d.ts +66 -56
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/util.d.ts +528 -70
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/v8.d.ts +271 -14
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/vm.d.ts +421 -34
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/wasi.d.ts +13 -19
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/worker_threads.d.ts +81 -37
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/node_modules/@types/node/zlib.d.ts +11 -11
- package/lib/publishing/github/node_modules/@types/jsonwebtoken/package.json +3 -3
- package/lib/publishing/github/node_modules/@types/node/README.md +1 -1
- package/lib/publishing/github/node_modules/@types/node/child_process.d.ts +41 -2
- package/lib/publishing/github/node_modules/@types/node/crypto.d.ts +77 -7
- package/lib/publishing/github/node_modules/@types/node/fs/promises.d.ts +15 -12
- package/lib/publishing/github/node_modules/@types/node/globals.d.ts +5 -3
- package/lib/publishing/github/node_modules/@types/node/http.d.ts +142 -53
- package/lib/publishing/github/node_modules/@types/node/http2.d.ts +1 -2
- package/lib/publishing/github/node_modules/@types/node/https.d.ts +192 -62
- package/lib/publishing/github/node_modules/@types/node/index.d.ts +1 -1
- package/lib/publishing/github/node_modules/@types/node/inspector.d.ts +1 -1
- package/lib/publishing/github/node_modules/@types/node/net.d.ts +1 -0
- package/lib/publishing/github/node_modules/@types/node/os.d.ts +1 -0
- package/lib/publishing/github/node_modules/@types/node/package.json +10 -3
- package/lib/publishing/github/node_modules/@types/node/path.d.ts +32 -21
- package/lib/publishing/github/node_modules/@types/node/stream.d.ts +99 -0
- package/lib/publishing/github/node_modules/@types/node/tls.d.ts +13 -13
- package/lib/publishing/github/node_modules/@types/node/ts4.8/assert.d.ts +128 -0
- package/lib/publishing/github/node_modules/@types/node/ts4.8/async_hooks.d.ts +229 -0
- package/lib/publishing/github/node_modules/@types/node/ts4.8/buffer.d.ts +89 -0
- package/lib/publishing/github/node_modules/@types/node/ts4.8/child_process.d.ts +553 -0
- package/lib/publishing/github/node_modules/@types/node/ts4.8/cluster.d.ts +265 -0
- package/lib/publishing/github/node_modules/@types/node/ts4.8/console.d.ts +142 -0
- package/lib/publishing/github/node_modules/@types/node/ts4.8/constants.d.ts +18 -0
- package/lib/publishing/github/node_modules/@types/node/ts4.8/crypto.d.ts +1283 -0
- package/lib/publishing/github/node_modules/@types/node/ts4.8/dgram.d.ts +144 -0
- package/lib/publishing/github/node_modules/@types/node/ts4.8/dns.d.ts +387 -0
- package/lib/publishing/github/node_modules/@types/node/ts4.8/domain.d.ts +27 -0
- package/lib/publishing/github/node_modules/@types/node/ts4.8/events.d.ts +82 -0
- package/lib/publishing/github/node_modules/@types/node/ts4.8/fs/promises.d.ts +572 -0
- package/lib/publishing/github/node_modules/@types/node/ts4.8/fs.d.ts +2281 -0
- package/lib/publishing/github/node_modules/@types/node/ts4.8/globals.d.ts +746 -0
- package/lib/publishing/github/node_modules/@types/node/ts4.8/globals.global.d.ts +1 -0
- package/lib/publishing/github/node_modules/@types/node/ts4.8/http.d.ts +580 -0
- package/lib/publishing/github/node_modules/@types/node/ts4.8/http2.d.ts +961 -0
- package/lib/publishing/github/node_modules/@types/node/ts4.8/https.d.ts +272 -0
- package/lib/publishing/github/node_modules/@types/node/ts4.8/index.d.ts +53 -0
- package/lib/publishing/github/node_modules/@types/node/ts4.8/inspector.d.ts +3051 -0
- package/lib/publishing/github/node_modules/@types/node/ts4.8/module.d.ts +56 -0
- package/lib/publishing/github/node_modules/@types/node/ts4.8/net.d.ts +309 -0
- package/lib/publishing/github/node_modules/@types/node/ts4.8/os.d.ts +243 -0
- package/lib/publishing/github/node_modules/@types/node/ts4.8/path.d.ts +168 -0
- package/lib/publishing/github/node_modules/@types/node/ts4.8/perf_hooks.d.ts +274 -0
- package/lib/publishing/github/node_modules/@types/node/ts4.8/process.d.ts +413 -0
- package/lib/publishing/github/node_modules/@types/node/ts4.8/punycode.d.ts +78 -0
- package/lib/publishing/github/node_modules/@types/node/ts4.8/querystring.d.ts +31 -0
- package/lib/publishing/github/node_modules/@types/node/ts4.8/readline.d.ts +174 -0
- package/lib/publishing/github/node_modules/@types/node/ts4.8/repl.d.ts +398 -0
- package/lib/publishing/github/node_modules/@types/node/ts4.8/stream.d.ts +458 -0
- package/lib/publishing/github/node_modules/@types/node/ts4.8/string_decoder.d.ts +10 -0
- package/lib/publishing/github/node_modules/@types/node/ts4.8/timers.d.ts +19 -0
- package/lib/publishing/github/node_modules/@types/node/ts4.8/tls.d.ts +784 -0
- package/lib/publishing/github/node_modules/@types/node/ts4.8/trace_events.d.ts +64 -0
- package/lib/publishing/github/node_modules/@types/node/ts4.8/tty.d.ts +69 -0
- package/lib/publishing/github/node_modules/@types/node/ts4.8/url.d.ts +177 -0
- package/lib/publishing/github/node_modules/@types/node/ts4.8/util.d.ts +216 -0
- package/lib/publishing/github/node_modules/@types/node/ts4.8/v8.d.ts +190 -0
- package/lib/publishing/github/node_modules/@types/node/ts4.8/vm.d.ts +155 -0
- package/lib/publishing/github/node_modules/@types/node/ts4.8/wasi.d.ts +89 -0
- package/lib/publishing/github/node_modules/@types/node/ts4.8/worker_threads.d.ts +241 -0
- package/lib/publishing/github/node_modules/@types/node/ts4.8/zlib.d.ts +364 -0
- package/lib/publishing/github/node_modules/@types/node/url.d.ts +28 -0
- package/lib/publishing/github/node_modules/before-after-hook/README.md +1 -3
- package/lib/publishing/github/node_modules/before-after-hook/index.d.ts +48 -48
- package/lib/publishing/github/node_modules/before-after-hook/index.js +43 -39
- package/lib/publishing/github/node_modules/before-after-hook/package.json +15 -10
- package/lib/publishing/github/node_modules/lru-cache/LICENSE +1 -1
- package/lib/publishing/github/node_modules/lru-cache/README.md +1127 -104
- package/lib/publishing/github/node_modules/lru-cache/dist/cjs/index.d.ts +834 -0
- package/lib/publishing/github/node_modules/lru-cache/dist/cjs/index.d.ts.map +1 -0
- package/lib/publishing/github/node_modules/lru-cache/dist/cjs/index.js +1395 -0
- package/lib/publishing/github/node_modules/lru-cache/dist/cjs/index.js.map +1 -0
- package/lib/publishing/github/node_modules/lru-cache/dist/cjs/index.min.js +2 -0
- package/lib/publishing/github/node_modules/lru-cache/dist/cjs/index.min.js.map +7 -0
- package/lib/publishing/github/node_modules/lru-cache/dist/cjs/package.json +3 -0
- package/lib/publishing/github/node_modules/lru-cache/dist/mjs/index.d.ts +834 -0
- package/lib/publishing/github/node_modules/lru-cache/dist/mjs/index.d.ts.map +1 -0
- package/lib/publishing/github/node_modules/lru-cache/dist/mjs/index.js +1391 -0
- package/lib/publishing/github/node_modules/lru-cache/dist/mjs/index.js.map +1 -0
- package/lib/publishing/github/node_modules/lru-cache/dist/mjs/index.min.js +2 -0
- package/lib/publishing/github/node_modules/lru-cache/dist/mjs/index.min.js.map +7 -0
- package/lib/publishing/github/node_modules/lru-cache/dist/mjs/package.json +3 -0
- package/lib/publishing/github/node_modules/lru-cache/package.json +86 -12
- package/lib/publishing/github/node_modules/node-fetch/README.md +43 -0
- package/lib/publishing/github/node_modules/node-fetch/browser.js +7 -7
- package/lib/publishing/github/node_modules/node-fetch/lib/index.es.js +92 -2
- package/lib/publishing/github/node_modules/node-fetch/lib/index.js +92 -2
- package/lib/publishing/github/node_modules/node-fetch/lib/index.mjs +92 -2
- package/lib/publishing/github/node_modules/node-fetch/package.json +16 -3
- package/lib/publishing/github/node_modules/octokit/README.md +4 -4
- package/lib/publishing/github/node_modules/octokit/dist-node/index.js +60 -33
- package/lib/publishing/github/node_modules/octokit/dist-node/index.js.map +7 -1
- package/lib/publishing/github/node_modules/octokit/dist-src/app.js +8 -3
- package/lib/publishing/github/node_modules/octokit/dist-src/index.js +8 -2
- package/lib/publishing/github/node_modules/octokit/dist-src/octokit.js +28 -20
- package/lib/publishing/github/node_modules/octokit/dist-src/version.js +4 -1
- package/lib/publishing/github/node_modules/octokit/dist-types/app.d.ts +2 -2
- package/lib/publishing/github/node_modules/octokit/dist-types/octokit.d.ts +1 -1
- package/lib/publishing/github/node_modules/octokit/dist-types/version.d.ts +1 -1
- package/lib/publishing/github/node_modules/octokit/dist-web/index.js +46 -34
- package/lib/publishing/github/node_modules/octokit/dist-web/index.js.map +7 -1
- package/lib/publishing/github/node_modules/octokit/package.json +26 -28
- package/lib/publishing/github/node_modules/semver/README.md +67 -0
- package/lib/publishing/github/node_modules/semver/bin/semver.js +16 -2
- package/lib/publishing/github/node_modules/semver/classes/comparator.js +37 -33
- package/lib/publishing/github/node_modules/semver/classes/range.js +6 -2
- package/lib/publishing/github/node_modules/semver/classes/semver.js +27 -14
- package/lib/publishing/github/node_modules/semver/functions/diff.js +48 -17
- package/lib/publishing/github/node_modules/semver/functions/inc.js +3 -2
- package/lib/publishing/github/node_modules/semver/functions/parse.js +5 -22
- package/lib/publishing/github/node_modules/semver/index.js +1 -0
- package/lib/publishing/github/node_modules/semver/internal/constants.js +15 -2
- package/lib/publishing/github/node_modules/semver/internal/parse-options.js +14 -10
- package/lib/publishing/github/node_modules/semver/node_modules/lru-cache/LICENSE +15 -0
- package/lib/publishing/github/node_modules/semver/node_modules/lru-cache/README.md +166 -0
- package/lib/publishing/github/node_modules/semver/node_modules/lru-cache/package.json +34 -0
- package/lib/publishing/github/node_modules/semver/package.json +7 -6
- package/lib/publishing/github/node_modules/semver/ranges/intersects.js +1 -1
- package/lib/publishing/github/node_modules/semver/ranges/subset.js +6 -3
- package/lib/publishing/github/node_modules/typescript/lib/tsc.js +8 -3
- package/lib/publishing/github/node_modules/typescript/lib/tsserver.js +13 -3
- package/lib/publishing/github/node_modules/typescript/lib/tsserverlibrary.js +13 -3
- package/lib/publishing/github/node_modules/typescript/lib/typescript.js +13 -3
- package/lib/publishing/github/node_modules/typescript/lib/typescriptServices.js +13 -3
- package/lib/publishing/github/node_modules/typescript/lib/typingsInstaller.js +13 -3
- package/lib/publishing/github/node_modules/typescript/package.json +1 -1
- package/lib/publishing/github/package-lock.json +675 -0
- package/lib/publishing/github/package.json +1 -1
- package/lib/publishing/github/publish.sh +3 -1
- package/package.json +1 -1
- package/lib/publishing/github/node_modules/@octokit/app/dist-src/types.js +0 -1
- package/lib/publishing/github/node_modules/@octokit/auth-app/dist-src/types.js +0 -1
- package/lib/publishing/github/node_modules/@octokit/auth-token/dist-src/types.js +0 -1
- package/lib/publishing/github/node_modules/@octokit/auth-unauthenticated/dist-src/types.js +0 -1
- package/lib/publishing/github/node_modules/@octokit/core/dist-src/types.js +0 -1
- package/lib/publishing/github/node_modules/@octokit/graphql/dist-src/types.js +0 -1
- package/lib/publishing/github/node_modules/@octokit/oauth-app/dist-src/middleware/types.js +0 -1
- package/lib/publishing/github/node_modules/@octokit/oauth-app/dist-src/types.js +0 -1
- package/lib/publishing/github/node_modules/@octokit/plugin-paginate-rest/dist-src/types.js +0 -1
- package/lib/publishing/github/node_modules/@octokit/webhooks/dist-src/middleware/node/types.js +0 -1
- package/lib/publishing/github/node_modules/@octokit/webhooks/dist-src/types.js +0 -1
- package/lib/publishing/github/node_modules/@types/lru-cache/LICENSE +0 -21
- package/lib/publishing/github/node_modules/@types/lru-cache/README.md +0 -16
- package/lib/publishing/github/node_modules/@types/lru-cache/index.d.ts +0 -193
- package/lib/publishing/github/node_modules/@types/lru-cache/package.json +0 -30
- package/lib/publishing/github/yarn.lock +0 -473
- /package/lib/publishing/github/node_modules/{lru-cache → semver/node_modules/lru-cache}/index.js +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { EndpointInterface, RequestInterface } from "@octokit/types";
|
|
2
2
|
import { RestEndpointMethodTypes } from "./parameters-and-response-types";
|
|
3
|
-
export
|
|
3
|
+
export type RestEndpointMethods = {
|
|
4
4
|
actions: {
|
|
5
5
|
/**
|
|
6
6
|
* Add custom labels to a self-hosted runner configured in an organization.
|
|
@@ -37,6 +37,30 @@ export declare type RestEndpointMethods = {
|
|
|
37
37
|
url: string;
|
|
38
38
|
}>;
|
|
39
39
|
};
|
|
40
|
+
/**
|
|
41
|
+
* Adds a repository to an organization variable that is available to selected repositories. Organization variables that are available to selected repositories have their `visibility` field set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint.
|
|
42
|
+
*/
|
|
43
|
+
addSelectedRepoToOrgVariable: {
|
|
44
|
+
(params?: RestEndpointMethodTypes["actions"]["addSelectedRepoToOrgVariable"]["parameters"]): Promise<RestEndpointMethodTypes["actions"]["addSelectedRepoToOrgVariable"]["response"]>;
|
|
45
|
+
defaults: RequestInterface["defaults"];
|
|
46
|
+
endpoint: EndpointInterface<{
|
|
47
|
+
url: string;
|
|
48
|
+
}>;
|
|
49
|
+
};
|
|
50
|
+
/**
|
|
51
|
+
* Adds a repository to a required workflow. To use this endpoint, the required workflow must be configured to run on selected repositories.
|
|
52
|
+
*
|
|
53
|
+
* You must authenticate using an access token with the `admin:org` scope to use this endpoint.
|
|
54
|
+
*
|
|
55
|
+
* For more information, see "[Required Workflows](https://docs.github.com/actions/using-workflows/required-workflows)."
|
|
56
|
+
*/
|
|
57
|
+
addSelectedRepoToRequiredWorkflow: {
|
|
58
|
+
(params?: RestEndpointMethodTypes["actions"]["addSelectedRepoToRequiredWorkflow"]["parameters"]): Promise<RestEndpointMethodTypes["actions"]["addSelectedRepoToRequiredWorkflow"]["response"]>;
|
|
59
|
+
defaults: RequestInterface["defaults"];
|
|
60
|
+
endpoint: EndpointInterface<{
|
|
61
|
+
url: string;
|
|
62
|
+
}>;
|
|
63
|
+
};
|
|
40
64
|
/**
|
|
41
65
|
* Approves a workflow run for a pull request from a public fork of a first time contributor. For more information, see ["Approving workflow runs from public forks](https://docs.github.com/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks)."
|
|
42
66
|
*
|
|
@@ -59,6 +83,18 @@ export declare type RestEndpointMethods = {
|
|
|
59
83
|
url: string;
|
|
60
84
|
}>;
|
|
61
85
|
};
|
|
86
|
+
/**
|
|
87
|
+
* Create an environment variable that you can reference in a GitHub Actions workflow.
|
|
88
|
+
* You must authenticate using an access token with the `repo` scope to use this endpoint.
|
|
89
|
+
* GitHub Apps must have the `environment:write` repository permission to use this endpoint.
|
|
90
|
+
*/
|
|
91
|
+
createEnvironmentVariable: {
|
|
92
|
+
(params?: RestEndpointMethodTypes["actions"]["createEnvironmentVariable"]["parameters"]): Promise<RestEndpointMethodTypes["actions"]["createEnvironmentVariable"]["response"]>;
|
|
93
|
+
defaults: RequestInterface["defaults"];
|
|
94
|
+
endpoint: EndpointInterface<{
|
|
95
|
+
url: string;
|
|
96
|
+
}>;
|
|
97
|
+
};
|
|
62
98
|
/**
|
|
63
99
|
* Creates or updates an environment secret with an encrypted value. Encrypt your secret using
|
|
64
100
|
* [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access
|
|
@@ -67,28 +103,29 @@ export declare type RestEndpointMethods = {
|
|
|
67
103
|
*
|
|
68
104
|
* #### Example encrypting a secret using Node.js
|
|
69
105
|
*
|
|
70
|
-
* Encrypt your secret using the [
|
|
106
|
+
* Encrypt your secret using the [libsodium-wrappers](https://www.npmjs.com/package/libsodium-wrappers) library.
|
|
71
107
|
*
|
|
72
108
|
* ```
|
|
73
|
-
* const sodium = require('
|
|
74
|
-
*
|
|
75
|
-
* const key =
|
|
76
|
-
* const value = "plain-text-secret";
|
|
109
|
+
* const sodium = require('libsodium-wrappers')
|
|
110
|
+
* const secret = 'plain-text-secret' // replace with the secret you want to encrypt
|
|
111
|
+
* const key = 'base64-encoded-public-key' // replace with the Base64 encoded public key
|
|
77
112
|
*
|
|
78
|
-
* //
|
|
79
|
-
*
|
|
80
|
-
*
|
|
113
|
+
* //Check if libsodium is ready and then proceed.
|
|
114
|
+
* sodium.ready.then(() => {
|
|
115
|
+
* // Convert Secret & Base64 key to Uint8Array.
|
|
116
|
+
* let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)
|
|
117
|
+
* let binsec = sodium.from_string(secret)
|
|
81
118
|
*
|
|
82
|
-
*
|
|
83
|
-
*
|
|
119
|
+
* //Encrypt the secret using LibSodium
|
|
120
|
+
* let encBytes = sodium.crypto_box_seal(binsec, binkey)
|
|
84
121
|
*
|
|
85
|
-
*
|
|
86
|
-
*
|
|
122
|
+
* // Convert encrypted Uint8Array to Base64
|
|
123
|
+
* let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)
|
|
87
124
|
*
|
|
88
|
-
*
|
|
125
|
+
* console.log(output)
|
|
126
|
+
* });
|
|
89
127
|
* ```
|
|
90
128
|
*
|
|
91
|
-
*
|
|
92
129
|
* #### Example encrypting a secret using Python
|
|
93
130
|
*
|
|
94
131
|
* Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3.
|
|
@@ -235,28 +272,29 @@ export declare type RestEndpointMethods = {
|
|
|
235
272
|
*
|
|
236
273
|
* #### Example encrypting a secret using Node.js
|
|
237
274
|
*
|
|
238
|
-
* Encrypt your secret using the [
|
|
275
|
+
* Encrypt your secret using the [libsodium-wrappers](https://www.npmjs.com/package/libsodium-wrappers) library.
|
|
239
276
|
*
|
|
240
277
|
* ```
|
|
241
|
-
* const sodium = require('
|
|
242
|
-
*
|
|
243
|
-
* const key =
|
|
244
|
-
* const value = "plain-text-secret";
|
|
278
|
+
* const sodium = require('libsodium-wrappers')
|
|
279
|
+
* const secret = 'plain-text-secret' // replace with the secret you want to encrypt
|
|
280
|
+
* const key = 'base64-encoded-public-key' // replace with the Base64 encoded public key
|
|
245
281
|
*
|
|
246
|
-
* //
|
|
247
|
-
*
|
|
248
|
-
*
|
|
282
|
+
* //Check if libsodium is ready and then proceed.
|
|
283
|
+
* sodium.ready.then(() => {
|
|
284
|
+
* // Convert Secret & Base64 key to Uint8Array.
|
|
285
|
+
* let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)
|
|
286
|
+
* let binsec = sodium.from_string(secret)
|
|
249
287
|
*
|
|
250
|
-
*
|
|
251
|
-
*
|
|
288
|
+
* //Encrypt the secret using LibSodium
|
|
289
|
+
* let encBytes = sodium.crypto_box_seal(binsec, binkey)
|
|
252
290
|
*
|
|
253
|
-
*
|
|
254
|
-
*
|
|
291
|
+
* // Convert encrypted Uint8Array to Base64
|
|
292
|
+
* let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)
|
|
255
293
|
*
|
|
256
|
-
*
|
|
294
|
+
* console.log(output)
|
|
295
|
+
* });
|
|
257
296
|
* ```
|
|
258
297
|
*
|
|
259
|
-
*
|
|
260
298
|
* #### Example encrypting a secret using Python
|
|
261
299
|
*
|
|
262
300
|
* Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3.
|
|
@@ -311,6 +349,18 @@ export declare type RestEndpointMethods = {
|
|
|
311
349
|
url: string;
|
|
312
350
|
}>;
|
|
313
351
|
};
|
|
352
|
+
/**
|
|
353
|
+
* Creates an organization variable that you can reference in a GitHub Actions workflow.
|
|
354
|
+
* You must authenticate using an access token with the `admin:org` scope to use this endpoint.
|
|
355
|
+
* GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint.
|
|
356
|
+
*/
|
|
357
|
+
createOrgVariable: {
|
|
358
|
+
(params?: RestEndpointMethodTypes["actions"]["createOrgVariable"]["parameters"]): Promise<RestEndpointMethodTypes["actions"]["createOrgVariable"]["response"]>;
|
|
359
|
+
defaults: RequestInterface["defaults"];
|
|
360
|
+
endpoint: EndpointInterface<{
|
|
361
|
+
url: string;
|
|
362
|
+
}>;
|
|
363
|
+
};
|
|
314
364
|
/**
|
|
315
365
|
* Returns a token that you can pass to the `config` script. The token expires after one hour.
|
|
316
366
|
*
|
|
@@ -390,6 +440,32 @@ export declare type RestEndpointMethods = {
|
|
|
390
440
|
url: string;
|
|
391
441
|
}>;
|
|
392
442
|
};
|
|
443
|
+
/**
|
|
444
|
+
* Creates a repository variable that you can reference in a GitHub Actions workflow.
|
|
445
|
+
* You must authenticate using an access token with the `repo` scope to use this endpoint.
|
|
446
|
+
* GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.
|
|
447
|
+
*/
|
|
448
|
+
createRepoVariable: {
|
|
449
|
+
(params?: RestEndpointMethodTypes["actions"]["createRepoVariable"]["parameters"]): Promise<RestEndpointMethodTypes["actions"]["createRepoVariable"]["response"]>;
|
|
450
|
+
defaults: RequestInterface["defaults"];
|
|
451
|
+
endpoint: EndpointInterface<{
|
|
452
|
+
url: string;
|
|
453
|
+
}>;
|
|
454
|
+
};
|
|
455
|
+
/**
|
|
456
|
+
* Create a required workflow in an organization.
|
|
457
|
+
*
|
|
458
|
+
* You must authenticate using an access token with the `admin:org` scope to use this endpoint.
|
|
459
|
+
*
|
|
460
|
+
* For more information, see "[Required Workflows](https://docs.github.com/actions/using-workflows/required-workflows)."
|
|
461
|
+
*/
|
|
462
|
+
createRequiredWorkflow: {
|
|
463
|
+
(params?: RestEndpointMethodTypes["actions"]["createRequiredWorkflow"]["parameters"]): Promise<RestEndpointMethodTypes["actions"]["createRequiredWorkflow"]["response"]>;
|
|
464
|
+
defaults: RequestInterface["defaults"];
|
|
465
|
+
endpoint: EndpointInterface<{
|
|
466
|
+
url: string;
|
|
467
|
+
}>;
|
|
468
|
+
};
|
|
393
469
|
/**
|
|
394
470
|
* You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.
|
|
395
471
|
*
|
|
@@ -452,6 +528,18 @@ export declare type RestEndpointMethods = {
|
|
|
452
528
|
url: string;
|
|
453
529
|
}>;
|
|
454
530
|
};
|
|
531
|
+
/**
|
|
532
|
+
* Deletes an environment variable using the variable name.
|
|
533
|
+
* You must authenticate using an access token with the `repo` scope to use this endpoint.
|
|
534
|
+
* GitHub Apps must have the `environment:write` repository permission to use this endpoint.
|
|
535
|
+
*/
|
|
536
|
+
deleteEnvironmentVariable: {
|
|
537
|
+
(params?: RestEndpointMethodTypes["actions"]["deleteEnvironmentVariable"]["parameters"]): Promise<RestEndpointMethodTypes["actions"]["deleteEnvironmentVariable"]["response"]>;
|
|
538
|
+
defaults: RequestInterface["defaults"];
|
|
539
|
+
endpoint: EndpointInterface<{
|
|
540
|
+
url: string;
|
|
541
|
+
}>;
|
|
542
|
+
};
|
|
455
543
|
/**
|
|
456
544
|
* Deletes a secret in an organization using the secret name. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.
|
|
457
545
|
*/
|
|
@@ -462,6 +550,18 @@ export declare type RestEndpointMethods = {
|
|
|
462
550
|
url: string;
|
|
463
551
|
}>;
|
|
464
552
|
};
|
|
553
|
+
/**
|
|
554
|
+
* Deletes an organization variable using the variable name.
|
|
555
|
+
* You must authenticate using an access token with the `admin:org` scope to use this endpoint.
|
|
556
|
+
* GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint.
|
|
557
|
+
*/
|
|
558
|
+
deleteOrgVariable: {
|
|
559
|
+
(params?: RestEndpointMethodTypes["actions"]["deleteOrgVariable"]["parameters"]): Promise<RestEndpointMethodTypes["actions"]["deleteOrgVariable"]["response"]>;
|
|
560
|
+
defaults: RequestInterface["defaults"];
|
|
561
|
+
endpoint: EndpointInterface<{
|
|
562
|
+
url: string;
|
|
563
|
+
}>;
|
|
564
|
+
};
|
|
465
565
|
/**
|
|
466
566
|
* Deletes a secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint.
|
|
467
567
|
*/
|
|
@@ -472,6 +572,32 @@ export declare type RestEndpointMethods = {
|
|
|
472
572
|
url: string;
|
|
473
573
|
}>;
|
|
474
574
|
};
|
|
575
|
+
/**
|
|
576
|
+
* Deletes a repository variable using the variable name.
|
|
577
|
+
* You must authenticate using an access token with the `repo` scope to use this endpoint.
|
|
578
|
+
* GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.
|
|
579
|
+
*/
|
|
580
|
+
deleteRepoVariable: {
|
|
581
|
+
(params?: RestEndpointMethodTypes["actions"]["deleteRepoVariable"]["parameters"]): Promise<RestEndpointMethodTypes["actions"]["deleteRepoVariable"]["response"]>;
|
|
582
|
+
defaults: RequestInterface["defaults"];
|
|
583
|
+
endpoint: EndpointInterface<{
|
|
584
|
+
url: string;
|
|
585
|
+
}>;
|
|
586
|
+
};
|
|
587
|
+
/**
|
|
588
|
+
* Deletes a required workflow configured in an organization.
|
|
589
|
+
*
|
|
590
|
+
* You must authenticate using an access token with the `admin:org` scope to use this endpoint.
|
|
591
|
+
*
|
|
592
|
+
* For more information, see "[Required Workflows](https://docs.github.com/actions/using-workflows/required-workflows)."
|
|
593
|
+
*/
|
|
594
|
+
deleteRequiredWorkflow: {
|
|
595
|
+
(params?: RestEndpointMethodTypes["actions"]["deleteRequiredWorkflow"]["parameters"]): Promise<RestEndpointMethodTypes["actions"]["deleteRequiredWorkflow"]["response"]>;
|
|
596
|
+
defaults: RequestInterface["defaults"];
|
|
597
|
+
endpoint: EndpointInterface<{
|
|
598
|
+
url: string;
|
|
599
|
+
}>;
|
|
600
|
+
};
|
|
475
601
|
/**
|
|
476
602
|
* Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.
|
|
477
603
|
*
|
|
@@ -655,18 +781,6 @@ export declare type RestEndpointMethods = {
|
|
|
655
781
|
url: string;
|
|
656
782
|
}>;
|
|
657
783
|
};
|
|
658
|
-
/**
|
|
659
|
-
* Gets the total GitHub Actions cache usage for an enterprise.
|
|
660
|
-
* The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.
|
|
661
|
-
* You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.
|
|
662
|
-
*/
|
|
663
|
-
getActionsCacheUsageForEnterprise: {
|
|
664
|
-
(params?: RestEndpointMethodTypes["actions"]["getActionsCacheUsageForEnterprise"]["parameters"]): Promise<RestEndpointMethodTypes["actions"]["getActionsCacheUsageForEnterprise"]["response"]>;
|
|
665
|
-
defaults: RequestInterface["defaults"];
|
|
666
|
-
endpoint: EndpointInterface<{
|
|
667
|
-
url: string;
|
|
668
|
-
}>;
|
|
669
|
-
};
|
|
670
784
|
/**
|
|
671
785
|
* Gets the total GitHub Actions cache usage for an organization.
|
|
672
786
|
* The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.
|
|
@@ -734,15 +848,10 @@ export declare type RestEndpointMethods = {
|
|
|
734
848
|
}>;
|
|
735
849
|
};
|
|
736
850
|
/**
|
|
737
|
-
* Gets
|
|
738
|
-
* as well as whether GitHub Actions can submit approving pull request reviews. For more information, see
|
|
739
|
-
* "[Enforcing a policy for workflow permissions in your enterprise](https://docs.github.com/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise)."
|
|
740
|
-
*
|
|
741
|
-
* You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.
|
|
742
|
-
* GitHub Apps must have the `enterprise_administration:write` permission to use this endpoint.
|
|
851
|
+
* Gets a specific variable in an environment. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `environments:read` repository permission to use this endpoint.
|
|
743
852
|
*/
|
|
744
|
-
|
|
745
|
-
(params?: RestEndpointMethodTypes["actions"]["
|
|
853
|
+
getEnvironmentVariable: {
|
|
854
|
+
(params?: RestEndpointMethodTypes["actions"]["getEnvironmentVariable"]["parameters"]): Promise<RestEndpointMethodTypes["actions"]["getEnvironmentVariable"]["response"]>;
|
|
746
855
|
defaults: RequestInterface["defaults"];
|
|
747
856
|
endpoint: EndpointInterface<{
|
|
748
857
|
url: string;
|
|
@@ -830,6 +939,16 @@ export declare type RestEndpointMethods = {
|
|
|
830
939
|
url: string;
|
|
831
940
|
}>;
|
|
832
941
|
};
|
|
942
|
+
/**
|
|
943
|
+
* Gets a specific variable in an organization. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `organization_actions_variables:read` organization permission to use this endpoint.
|
|
944
|
+
*/
|
|
945
|
+
getOrgVariable: {
|
|
946
|
+
(params?: RestEndpointMethodTypes["actions"]["getOrgVariable"]["parameters"]): Promise<RestEndpointMethodTypes["actions"]["getOrgVariable"]["response"]>;
|
|
947
|
+
defaults: RequestInterface["defaults"];
|
|
948
|
+
endpoint: EndpointInterface<{
|
|
949
|
+
url: string;
|
|
950
|
+
}>;
|
|
951
|
+
};
|
|
833
952
|
/**
|
|
834
953
|
* Get all deployment environments for a workflow run that are waiting for protection rules to pass.
|
|
835
954
|
*
|
|
@@ -865,6 +984,30 @@ export declare type RestEndpointMethods = {
|
|
|
865
984
|
url: string;
|
|
866
985
|
}>;
|
|
867
986
|
};
|
|
987
|
+
/**
|
|
988
|
+
* Gets a specific required workflow present in a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. For more information, see "[Required Workflows](https://docs.github.com/actions/using-workflows/required-workflows)."
|
|
989
|
+
*/
|
|
990
|
+
getRepoRequiredWorkflow: {
|
|
991
|
+
(params?: RestEndpointMethodTypes["actions"]["getRepoRequiredWorkflow"]["parameters"]): Promise<RestEndpointMethodTypes["actions"]["getRepoRequiredWorkflow"]["response"]>;
|
|
992
|
+
defaults: RequestInterface["defaults"];
|
|
993
|
+
endpoint: EndpointInterface<{
|
|
994
|
+
url: string;
|
|
995
|
+
}>;
|
|
996
|
+
};
|
|
997
|
+
/**
|
|
998
|
+
* Gets the number of billable minutes used by a specific required workflow during the current billing cycle.
|
|
999
|
+
*
|
|
1000
|
+
* Billable minutes only apply to required workflows running in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)."
|
|
1001
|
+
*
|
|
1002
|
+
* Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.
|
|
1003
|
+
*/
|
|
1004
|
+
getRepoRequiredWorkflowUsage: {
|
|
1005
|
+
(params?: RestEndpointMethodTypes["actions"]["getRepoRequiredWorkflowUsage"]["parameters"]): Promise<RestEndpointMethodTypes["actions"]["getRepoRequiredWorkflowUsage"]["response"]>;
|
|
1006
|
+
defaults: RequestInterface["defaults"];
|
|
1007
|
+
endpoint: EndpointInterface<{
|
|
1008
|
+
url: string;
|
|
1009
|
+
}>;
|
|
1010
|
+
};
|
|
868
1011
|
/**
|
|
869
1012
|
* Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint.
|
|
870
1013
|
*/
|
|
@@ -875,6 +1018,30 @@ export declare type RestEndpointMethods = {
|
|
|
875
1018
|
url: string;
|
|
876
1019
|
}>;
|
|
877
1020
|
};
|
|
1021
|
+
/**
|
|
1022
|
+
* Gets a specific variable in a repository. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.
|
|
1023
|
+
*/
|
|
1024
|
+
getRepoVariable: {
|
|
1025
|
+
(params?: RestEndpointMethodTypes["actions"]["getRepoVariable"]["parameters"]): Promise<RestEndpointMethodTypes["actions"]["getRepoVariable"]["response"]>;
|
|
1026
|
+
defaults: RequestInterface["defaults"];
|
|
1027
|
+
endpoint: EndpointInterface<{
|
|
1028
|
+
url: string;
|
|
1029
|
+
}>;
|
|
1030
|
+
};
|
|
1031
|
+
/**
|
|
1032
|
+
* Get a required workflow configured in an organization.
|
|
1033
|
+
*
|
|
1034
|
+
* You must authenticate using an access token with the `read:org` scope to use this endpoint.
|
|
1035
|
+
*
|
|
1036
|
+
* For more information, see "[Required Workflows](https://docs.github.com/actions/using-workflows/required-workflows)."
|
|
1037
|
+
*/
|
|
1038
|
+
getRequiredWorkflow: {
|
|
1039
|
+
(params?: RestEndpointMethodTypes["actions"]["getRequiredWorkflow"]["parameters"]): Promise<RestEndpointMethodTypes["actions"]["getRequiredWorkflow"]["response"]>;
|
|
1040
|
+
defaults: RequestInterface["defaults"];
|
|
1041
|
+
endpoint: EndpointInterface<{
|
|
1042
|
+
url: string;
|
|
1043
|
+
}>;
|
|
1044
|
+
};
|
|
878
1045
|
/**
|
|
879
1046
|
* Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.
|
|
880
1047
|
*/
|
|
@@ -922,7 +1089,8 @@ export declare type RestEndpointMethods = {
|
|
|
922
1089
|
};
|
|
923
1090
|
/**
|
|
924
1091
|
* Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.
|
|
925
|
-
* This endpoint only applies to
|
|
1092
|
+
* This endpoint only applies to private repositories.
|
|
1093
|
+
* For more information, see "[Allowing access to components in a private repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)."
|
|
926
1094
|
*
|
|
927
1095
|
* You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the
|
|
928
1096
|
* repository `administration` permission to use this endpoint.
|
|
@@ -1001,6 +1169,16 @@ export declare type RestEndpointMethods = {
|
|
|
1001
1169
|
url: string;
|
|
1002
1170
|
}>;
|
|
1003
1171
|
};
|
|
1172
|
+
/**
|
|
1173
|
+
* Lists all environment variables. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `environments:read` repository permission to use this endpoint.
|
|
1174
|
+
*/
|
|
1175
|
+
listEnvironmentVariables: {
|
|
1176
|
+
(params?: RestEndpointMethodTypes["actions"]["listEnvironmentVariables"]["parameters"]): Promise<RestEndpointMethodTypes["actions"]["listEnvironmentVariables"]["response"]>;
|
|
1177
|
+
defaults: RequestInterface["defaults"];
|
|
1178
|
+
endpoint: EndpointInterface<{
|
|
1179
|
+
url: string;
|
|
1180
|
+
}>;
|
|
1181
|
+
};
|
|
1004
1182
|
/**
|
|
1005
1183
|
* Lists jobs for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters).
|
|
1006
1184
|
*/
|
|
@@ -1056,6 +1234,46 @@ export declare type RestEndpointMethods = {
|
|
|
1056
1234
|
url: string;
|
|
1057
1235
|
}>;
|
|
1058
1236
|
};
|
|
1237
|
+
/**
|
|
1238
|
+
* Lists all organization variables. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `organization_actions_variables:read` organization permission to use this endpoint.
|
|
1239
|
+
*/
|
|
1240
|
+
listOrgVariables: {
|
|
1241
|
+
(params?: RestEndpointMethodTypes["actions"]["listOrgVariables"]["parameters"]): Promise<RestEndpointMethodTypes["actions"]["listOrgVariables"]["response"]>;
|
|
1242
|
+
defaults: RequestInterface["defaults"];
|
|
1243
|
+
endpoint: EndpointInterface<{
|
|
1244
|
+
url: string;
|
|
1245
|
+
}>;
|
|
1246
|
+
};
|
|
1247
|
+
/**
|
|
1248
|
+
* Lists all organization secrets shared with a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint.
|
|
1249
|
+
*/
|
|
1250
|
+
listRepoOrganizationSecrets: {
|
|
1251
|
+
(params?: RestEndpointMethodTypes["actions"]["listRepoOrganizationSecrets"]["parameters"]): Promise<RestEndpointMethodTypes["actions"]["listRepoOrganizationSecrets"]["response"]>;
|
|
1252
|
+
defaults: RequestInterface["defaults"];
|
|
1253
|
+
endpoint: EndpointInterface<{
|
|
1254
|
+
url: string;
|
|
1255
|
+
}>;
|
|
1256
|
+
};
|
|
1257
|
+
/**
|
|
1258
|
+
* Lists all organiation variables shared with a repository. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.
|
|
1259
|
+
*/
|
|
1260
|
+
listRepoOrganizationVariables: {
|
|
1261
|
+
(params?: RestEndpointMethodTypes["actions"]["listRepoOrganizationVariables"]["parameters"]): Promise<RestEndpointMethodTypes["actions"]["listRepoOrganizationVariables"]["response"]>;
|
|
1262
|
+
defaults: RequestInterface["defaults"];
|
|
1263
|
+
endpoint: EndpointInterface<{
|
|
1264
|
+
url: string;
|
|
1265
|
+
}>;
|
|
1266
|
+
};
|
|
1267
|
+
/**
|
|
1268
|
+
* Lists the required workflows in a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. For more information, see "[Required Workflows](https://docs.github.com/actions/using-workflows/required-workflows)."
|
|
1269
|
+
*/
|
|
1270
|
+
listRepoRequiredWorkflows: {
|
|
1271
|
+
(params?: RestEndpointMethodTypes["actions"]["listRepoRequiredWorkflows"]["parameters"]): Promise<RestEndpointMethodTypes["actions"]["listRepoRequiredWorkflows"]["response"]>;
|
|
1272
|
+
defaults: RequestInterface["defaults"];
|
|
1273
|
+
endpoint: EndpointInterface<{
|
|
1274
|
+
url: string;
|
|
1275
|
+
}>;
|
|
1276
|
+
};
|
|
1059
1277
|
/**
|
|
1060
1278
|
* Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint.
|
|
1061
1279
|
*/
|
|
@@ -1066,6 +1284,16 @@ export declare type RestEndpointMethods = {
|
|
|
1066
1284
|
url: string;
|
|
1067
1285
|
}>;
|
|
1068
1286
|
};
|
|
1287
|
+
/**
|
|
1288
|
+
* Lists all repository variables. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.
|
|
1289
|
+
*/
|
|
1290
|
+
listRepoVariables: {
|
|
1291
|
+
(params?: RestEndpointMethodTypes["actions"]["listRepoVariables"]["parameters"]): Promise<RestEndpointMethodTypes["actions"]["listRepoVariables"]["response"]>;
|
|
1292
|
+
defaults: RequestInterface["defaults"];
|
|
1293
|
+
endpoint: EndpointInterface<{
|
|
1294
|
+
url: string;
|
|
1295
|
+
}>;
|
|
1296
|
+
};
|
|
1069
1297
|
/**
|
|
1070
1298
|
* Lists the workflows in a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.
|
|
1071
1299
|
*/
|
|
@@ -1076,6 +1304,32 @@ export declare type RestEndpointMethods = {
|
|
|
1076
1304
|
url: string;
|
|
1077
1305
|
}>;
|
|
1078
1306
|
};
|
|
1307
|
+
/**
|
|
1308
|
+
* List all workflow runs for a required workflow. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters).
|
|
1309
|
+
*
|
|
1310
|
+
* Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. For more information, see "[Required Workflows](https://docs.github.com/actions/using-workflows/required-workflows)."
|
|
1311
|
+
*/
|
|
1312
|
+
listRequiredWorkflowRuns: {
|
|
1313
|
+
(params?: RestEndpointMethodTypes["actions"]["listRequiredWorkflowRuns"]["parameters"]): Promise<RestEndpointMethodTypes["actions"]["listRequiredWorkflowRuns"]["response"]>;
|
|
1314
|
+
defaults: RequestInterface["defaults"];
|
|
1315
|
+
endpoint: EndpointInterface<{
|
|
1316
|
+
url: string;
|
|
1317
|
+
}>;
|
|
1318
|
+
};
|
|
1319
|
+
/**
|
|
1320
|
+
* List all required workflows in an organization.
|
|
1321
|
+
*
|
|
1322
|
+
* You must authenticate using an access token with the `read:org` scope to use this endpoint.
|
|
1323
|
+
*
|
|
1324
|
+
* For more information, see "[Required Workflows](https://docs.github.com/actions/using-workflows/required-workflows)."
|
|
1325
|
+
*/
|
|
1326
|
+
listRequiredWorkflows: {
|
|
1327
|
+
(params?: RestEndpointMethodTypes["actions"]["listRequiredWorkflows"]["parameters"]): Promise<RestEndpointMethodTypes["actions"]["listRequiredWorkflows"]["response"]>;
|
|
1328
|
+
defaults: RequestInterface["defaults"];
|
|
1329
|
+
endpoint: EndpointInterface<{
|
|
1330
|
+
url: string;
|
|
1331
|
+
}>;
|
|
1332
|
+
};
|
|
1079
1333
|
/**
|
|
1080
1334
|
* Lists binaries for the runner application that you can download and run.
|
|
1081
1335
|
*
|
|
@@ -1110,6 +1364,16 @@ export declare type RestEndpointMethods = {
|
|
|
1110
1364
|
url: string;
|
|
1111
1365
|
}>;
|
|
1112
1366
|
};
|
|
1367
|
+
/**
|
|
1368
|
+
* Lists all repositories that can access an organization variable that is available to selected repositories. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `organization_actions_variables:read` organization permission to use this endpoint.
|
|
1369
|
+
*/
|
|
1370
|
+
listSelectedReposForOrgVariable: {
|
|
1371
|
+
(params?: RestEndpointMethodTypes["actions"]["listSelectedReposForOrgVariable"]["parameters"]): Promise<RestEndpointMethodTypes["actions"]["listSelectedReposForOrgVariable"]["response"]>;
|
|
1372
|
+
defaults: RequestInterface["defaults"];
|
|
1373
|
+
endpoint: EndpointInterface<{
|
|
1374
|
+
url: string;
|
|
1375
|
+
}>;
|
|
1376
|
+
};
|
|
1113
1377
|
/**
|
|
1114
1378
|
* Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."
|
|
1115
1379
|
*
|
|
@@ -1122,6 +1386,20 @@ export declare type RestEndpointMethods = {
|
|
|
1122
1386
|
url: string;
|
|
1123
1387
|
}>;
|
|
1124
1388
|
};
|
|
1389
|
+
/**
|
|
1390
|
+
* Lists the selected repositories that are configured for a required workflow in an organization. To use this endpoint, the required workflow must be configured to run on selected repositories.
|
|
1391
|
+
*
|
|
1392
|
+
* You must authenticate using an access token with the `read:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this endpoint.
|
|
1393
|
+
*
|
|
1394
|
+
* For more information, see "[Required Workflows](https://docs.github.com/actions/using-workflows/required-workflows)."
|
|
1395
|
+
*/
|
|
1396
|
+
listSelectedRepositoriesRequiredWorkflow: {
|
|
1397
|
+
(params?: RestEndpointMethodTypes["actions"]["listSelectedRepositoriesRequiredWorkflow"]["parameters"]): Promise<RestEndpointMethodTypes["actions"]["listSelectedRepositoriesRequiredWorkflow"]["response"]>;
|
|
1398
|
+
defaults: RequestInterface["defaults"];
|
|
1399
|
+
endpoint: EndpointInterface<{
|
|
1400
|
+
url: string;
|
|
1401
|
+
}>;
|
|
1402
|
+
};
|
|
1125
1403
|
/**
|
|
1126
1404
|
* Lists all self-hosted runners configured in an organization.
|
|
1127
1405
|
*
|
|
@@ -1278,6 +1556,45 @@ export declare type RestEndpointMethods = {
|
|
|
1278
1556
|
url: string;
|
|
1279
1557
|
}>;
|
|
1280
1558
|
};
|
|
1559
|
+
/**
|
|
1560
|
+
* Removes a repository from an organization variable that is available to selected repositories. Organization variables that are available to selected repositories have their `visibility` field set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint.
|
|
1561
|
+
*/
|
|
1562
|
+
removeSelectedRepoFromOrgVariable: {
|
|
1563
|
+
(params?: RestEndpointMethodTypes["actions"]["removeSelectedRepoFromOrgVariable"]["parameters"]): Promise<RestEndpointMethodTypes["actions"]["removeSelectedRepoFromOrgVariable"]["response"]>;
|
|
1564
|
+
defaults: RequestInterface["defaults"];
|
|
1565
|
+
endpoint: EndpointInterface<{
|
|
1566
|
+
url: string;
|
|
1567
|
+
}>;
|
|
1568
|
+
};
|
|
1569
|
+
/**
|
|
1570
|
+
* Removes a repository from a required workflow. To use this endpoint, the required workflow must be configured to run on selected repositories.
|
|
1571
|
+
*
|
|
1572
|
+
* You must authenticate using an access token with the `admin:org` scope to use this endpoint.
|
|
1573
|
+
*
|
|
1574
|
+
* For more information, see "[Required Workflows](https://docs.github.com/actions/using-workflows/required-workflows)."
|
|
1575
|
+
*/
|
|
1576
|
+
removeSelectedRepoFromRequiredWorkflow: {
|
|
1577
|
+
(params?: RestEndpointMethodTypes["actions"]["removeSelectedRepoFromRequiredWorkflow"]["parameters"]): Promise<RestEndpointMethodTypes["actions"]["removeSelectedRepoFromRequiredWorkflow"]["response"]>;
|
|
1578
|
+
defaults: RequestInterface["defaults"];
|
|
1579
|
+
endpoint: EndpointInterface<{
|
|
1580
|
+
url: string;
|
|
1581
|
+
}>;
|
|
1582
|
+
};
|
|
1583
|
+
/**
|
|
1584
|
+
* Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)."
|
|
1585
|
+
*
|
|
1586
|
+
* **Note:** GitHub Apps can only review their own custom deployment protection rules.
|
|
1587
|
+
* To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run).
|
|
1588
|
+
*
|
|
1589
|
+
* GitHub Apps must have read and write permission for **Deployments** to use this endpoint.
|
|
1590
|
+
*/
|
|
1591
|
+
reviewCustomGatesForRun: {
|
|
1592
|
+
(params?: RestEndpointMethodTypes["actions"]["reviewCustomGatesForRun"]["parameters"]): Promise<RestEndpointMethodTypes["actions"]["reviewCustomGatesForRun"]["response"]>;
|
|
1593
|
+
defaults: RequestInterface["defaults"];
|
|
1594
|
+
endpoint: EndpointInterface<{
|
|
1595
|
+
url: string;
|
|
1596
|
+
}>;
|
|
1597
|
+
};
|
|
1281
1598
|
/**
|
|
1282
1599
|
* Approve or reject pending deployments that are waiting on approval by a required reviewer.
|
|
1283
1600
|
*
|
|
@@ -1293,10 +1610,6 @@ export declare type RestEndpointMethods = {
|
|
|
1293
1610
|
/**
|
|
1294
1611
|
* Sets the actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."
|
|
1295
1612
|
*
|
|
1296
|
-
* If the organization belongs to an enterprise that has `selected` actions and reusable workflows set at the enterprise level, then you cannot override any of the enterprise's allowed actions and reusable workflows settings.
|
|
1297
|
-
*
|
|
1298
|
-
* To use the `patterns_allowed` setting for private repositories, the organization must belong to an enterprise. If the organization does not belong to an enterprise, then the `patterns_allowed` setting only applies to public repositories in the organization.
|
|
1299
|
-
*
|
|
1300
1613
|
* You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.
|
|
1301
1614
|
*/
|
|
1302
1615
|
setAllowedActionsOrganization: {
|
|
@@ -1309,10 +1622,6 @@ export declare type RestEndpointMethods = {
|
|
|
1309
1622
|
/**
|
|
1310
1623
|
* Sets the actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)."
|
|
1311
1624
|
*
|
|
1312
|
-
* If the repository belongs to an organization or enterprise that has `selected` actions and reusable workflows set at the organization or enterprise levels, then you cannot override any of the allowed actions and reusable workflows settings.
|
|
1313
|
-
*
|
|
1314
|
-
* To use the `patterns_allowed` setting for private repositories, the repository must belong to an enterprise. If the repository does not belong to an enterprise, then the `patterns_allowed` setting only applies to public repositories.
|
|
1315
|
-
*
|
|
1316
1625
|
* You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.
|
|
1317
1626
|
*/
|
|
1318
1627
|
setAllowedActionsRepository: {
|
|
@@ -1349,21 +1658,6 @@ export declare type RestEndpointMethods = {
|
|
|
1349
1658
|
url: string;
|
|
1350
1659
|
}>;
|
|
1351
1660
|
};
|
|
1352
|
-
/**
|
|
1353
|
-
* Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an enterprise, and sets
|
|
1354
|
-
* whether GitHub Actions can submit approving pull request reviews. For more information, see
|
|
1355
|
-
* "[Enforcing a policy for workflow permissions in your enterprise](https://docs.github.com/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise)."
|
|
1356
|
-
*
|
|
1357
|
-
* You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.
|
|
1358
|
-
* GitHub Apps must have the `enterprise_administration:write` permission to use this endpoint.
|
|
1359
|
-
*/
|
|
1360
|
-
setGithubActionsDefaultWorkflowPermissionsEnterprise: {
|
|
1361
|
-
(params?: RestEndpointMethodTypes["actions"]["setGithubActionsDefaultWorkflowPermissionsEnterprise"]["parameters"]): Promise<RestEndpointMethodTypes["actions"]["setGithubActionsDefaultWorkflowPermissionsEnterprise"]["response"]>;
|
|
1362
|
-
defaults: RequestInterface["defaults"];
|
|
1363
|
-
endpoint: EndpointInterface<{
|
|
1364
|
-
url: string;
|
|
1365
|
-
}>;
|
|
1366
|
-
};
|
|
1367
1661
|
/**
|
|
1368
1662
|
* Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, and sets if GitHub Actions
|
|
1369
1663
|
* can submit approving pull request reviews. For more information, see
|
|
@@ -1395,8 +1689,6 @@ export declare type RestEndpointMethods = {
|
|
|
1395
1689
|
/**
|
|
1396
1690
|
* Sets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization.
|
|
1397
1691
|
*
|
|
1398
|
-
* If the organization belongs to an enterprise that has set restrictive permissions at the enterprise level, such as `allowed_actions` to `selected` actions and reusable workflows, then you cannot override them for the organization.
|
|
1399
|
-
*
|
|
1400
1692
|
* You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.
|
|
1401
1693
|
*/
|
|
1402
1694
|
setGithubActionsPermissionsOrganization: {
|
|
@@ -1409,8 +1701,6 @@ export declare type RestEndpointMethods = {
|
|
|
1409
1701
|
/**
|
|
1410
1702
|
* Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions and reusable workflows in the repository.
|
|
1411
1703
|
*
|
|
1412
|
-
* If the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as `allowed_actions` to `selected` actions and reusable workflows, then you cannot override them for the repository.
|
|
1413
|
-
*
|
|
1414
1704
|
* You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.
|
|
1415
1705
|
*/
|
|
1416
1706
|
setGithubActionsPermissionsRepository: {
|
|
@@ -1430,6 +1720,30 @@ export declare type RestEndpointMethods = {
|
|
|
1430
1720
|
url: string;
|
|
1431
1721
|
}>;
|
|
1432
1722
|
};
|
|
1723
|
+
/**
|
|
1724
|
+
* Replaces all repositories for an organization variable that is available to selected repositories. Organization variables that are available to selected repositories have their `visibility` field set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint.
|
|
1725
|
+
*/
|
|
1726
|
+
setSelectedReposForOrgVariable: {
|
|
1727
|
+
(params?: RestEndpointMethodTypes["actions"]["setSelectedReposForOrgVariable"]["parameters"]): Promise<RestEndpointMethodTypes["actions"]["setSelectedReposForOrgVariable"]["response"]>;
|
|
1728
|
+
defaults: RequestInterface["defaults"];
|
|
1729
|
+
endpoint: EndpointInterface<{
|
|
1730
|
+
url: string;
|
|
1731
|
+
}>;
|
|
1732
|
+
};
|
|
1733
|
+
/**
|
|
1734
|
+
* Sets the repositories for a required workflow that is required for selected repositories.
|
|
1735
|
+
*
|
|
1736
|
+
* You must authenticate using an access token with the `admin:org` scope to use this endpoint.
|
|
1737
|
+
*
|
|
1738
|
+
* For more information, see "[Required Workflows](https://docs.github.com/actions/using-workflows/required-workflows)."
|
|
1739
|
+
*/
|
|
1740
|
+
setSelectedReposToRequiredWorkflow: {
|
|
1741
|
+
(params?: RestEndpointMethodTypes["actions"]["setSelectedReposToRequiredWorkflow"]["parameters"]): Promise<RestEndpointMethodTypes["actions"]["setSelectedReposToRequiredWorkflow"]["response"]>;
|
|
1742
|
+
defaults: RequestInterface["defaults"];
|
|
1743
|
+
endpoint: EndpointInterface<{
|
|
1744
|
+
url: string;
|
|
1745
|
+
}>;
|
|
1746
|
+
};
|
|
1433
1747
|
/**
|
|
1434
1748
|
* Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."
|
|
1435
1749
|
*
|
|
@@ -1444,7 +1758,8 @@ export declare type RestEndpointMethods = {
|
|
|
1444
1758
|
};
|
|
1445
1759
|
/**
|
|
1446
1760
|
* Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.
|
|
1447
|
-
* This endpoint only applies to
|
|
1761
|
+
* This endpoint only applies to private repositories.
|
|
1762
|
+
* For more information, see "[Allowing access to components in a private repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)".
|
|
1448
1763
|
*
|
|
1449
1764
|
* You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the
|
|
1450
1765
|
* repository `administration` permission to use this endpoint.
|
|
@@ -1456,6 +1771,56 @@ export declare type RestEndpointMethods = {
|
|
|
1456
1771
|
url: string;
|
|
1457
1772
|
}>;
|
|
1458
1773
|
};
|
|
1774
|
+
/**
|
|
1775
|
+
* Updates an environment variable that you can reference in a GitHub Actions workflow.
|
|
1776
|
+
* You must authenticate using an access token with the `repo` scope to use this endpoint.
|
|
1777
|
+
* GitHub Apps must have the `environment:write` repository permission to use this endpoint.
|
|
1778
|
+
*/
|
|
1779
|
+
updateEnvironmentVariable: {
|
|
1780
|
+
(params?: RestEndpointMethodTypes["actions"]["updateEnvironmentVariable"]["parameters"]): Promise<RestEndpointMethodTypes["actions"]["updateEnvironmentVariable"]["response"]>;
|
|
1781
|
+
defaults: RequestInterface["defaults"];
|
|
1782
|
+
endpoint: EndpointInterface<{
|
|
1783
|
+
url: string;
|
|
1784
|
+
}>;
|
|
1785
|
+
};
|
|
1786
|
+
/**
|
|
1787
|
+
* Updates an organization variable that you can reference in a GitHub Actions workflow.
|
|
1788
|
+
* You must authenticate using an access token with the `admin:org` scope to use this endpoint.
|
|
1789
|
+
* GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint.
|
|
1790
|
+
*/
|
|
1791
|
+
updateOrgVariable: {
|
|
1792
|
+
(params?: RestEndpointMethodTypes["actions"]["updateOrgVariable"]["parameters"]): Promise<RestEndpointMethodTypes["actions"]["updateOrgVariable"]["response"]>;
|
|
1793
|
+
defaults: RequestInterface["defaults"];
|
|
1794
|
+
endpoint: EndpointInterface<{
|
|
1795
|
+
url: string;
|
|
1796
|
+
}>;
|
|
1797
|
+
};
|
|
1798
|
+
/**
|
|
1799
|
+
* Updates a repository variable that you can reference in a GitHub Actions workflow.
|
|
1800
|
+
* You must authenticate using an access token with the `repo` scope to use this endpoint.
|
|
1801
|
+
* GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.
|
|
1802
|
+
*/
|
|
1803
|
+
updateRepoVariable: {
|
|
1804
|
+
(params?: RestEndpointMethodTypes["actions"]["updateRepoVariable"]["parameters"]): Promise<RestEndpointMethodTypes["actions"]["updateRepoVariable"]["response"]>;
|
|
1805
|
+
defaults: RequestInterface["defaults"];
|
|
1806
|
+
endpoint: EndpointInterface<{
|
|
1807
|
+
url: string;
|
|
1808
|
+
}>;
|
|
1809
|
+
};
|
|
1810
|
+
/**
|
|
1811
|
+
* Update a required workflow in an organization.
|
|
1812
|
+
*
|
|
1813
|
+
* You must authenticate using an access token with the `admin:org` scope to use this endpoint.
|
|
1814
|
+
*
|
|
1815
|
+
* For more information, see "[Required Workflows](https://docs.github.com/actions/using-workflows/required-workflows)."
|
|
1816
|
+
*/
|
|
1817
|
+
updateRequiredWorkflow: {
|
|
1818
|
+
(params?: RestEndpointMethodTypes["actions"]["updateRequiredWorkflow"]["parameters"]): Promise<RestEndpointMethodTypes["actions"]["updateRequiredWorkflow"]["response"]>;
|
|
1819
|
+
defaults: RequestInterface["defaults"];
|
|
1820
|
+
endpoint: EndpointInterface<{
|
|
1821
|
+
url: string;
|
|
1822
|
+
}>;
|
|
1823
|
+
};
|
|
1459
1824
|
};
|
|
1460
1825
|
activity: {
|
|
1461
1826
|
checkRepoIsStarredByAuthenticatedUser: {
|
|
@@ -1512,6 +1877,9 @@ export declare type RestEndpointMethods = {
|
|
|
1512
1877
|
url: string;
|
|
1513
1878
|
}>;
|
|
1514
1879
|
};
|
|
1880
|
+
/**
|
|
1881
|
+
* Gets information about a notification thread.
|
|
1882
|
+
*/
|
|
1515
1883
|
getThread: {
|
|
1516
1884
|
(params?: RestEndpointMethodTypes["activity"]["getThread"]["parameters"]): Promise<RestEndpointMethodTypes["activity"]["getThread"]["response"]>;
|
|
1517
1885
|
defaults: RequestInterface["defaults"];
|
|
@@ -1609,6 +1977,9 @@ export declare type RestEndpointMethods = {
|
|
|
1609
1977
|
url: string;
|
|
1610
1978
|
}>;
|
|
1611
1979
|
};
|
|
1980
|
+
/**
|
|
1981
|
+
* **Note**: This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
|
|
1982
|
+
*/
|
|
1612
1983
|
listRepoEvents: {
|
|
1613
1984
|
(params?: RestEndpointMethodTypes["activity"]["listRepoEvents"]["parameters"]): Promise<RestEndpointMethodTypes["activity"]["listRepoEvents"]["response"]>;
|
|
1614
1985
|
defaults: RequestInterface["defaults"];
|
|
@@ -1617,7 +1988,7 @@ export declare type RestEndpointMethods = {
|
|
|
1617
1988
|
}>;
|
|
1618
1989
|
};
|
|
1619
1990
|
/**
|
|
1620
|
-
*
|
|
1991
|
+
* Lists all notifications for the current user in the specified repository.
|
|
1621
1992
|
*/
|
|
1622
1993
|
listRepoNotificationsForAuthenticatedUser: {
|
|
1623
1994
|
(params?: RestEndpointMethodTypes["activity"]["listRepoNotificationsForAuthenticatedUser"]["parameters"]): Promise<RestEndpointMethodTypes["activity"]["listRepoNotificationsForAuthenticatedUser"]["response"]>;
|
|
@@ -1693,7 +2064,7 @@ export declare type RestEndpointMethods = {
|
|
|
1693
2064
|
}>;
|
|
1694
2065
|
};
|
|
1695
2066
|
/**
|
|
1696
|
-
* Marks all notifications as "read"
|
|
2067
|
+
* Marks all notifications as "read" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/rest/reference/activity#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.
|
|
1697
2068
|
*/
|
|
1698
2069
|
markNotificationsAsRead: {
|
|
1699
2070
|
(params?: RestEndpointMethodTypes["activity"]["markNotificationsAsRead"]["parameters"]): Promise<RestEndpointMethodTypes["activity"]["markNotificationsAsRead"]["response"]>;
|
|
@@ -1703,7 +2074,7 @@ export declare type RestEndpointMethods = {
|
|
|
1703
2074
|
}>;
|
|
1704
2075
|
};
|
|
1705
2076
|
/**
|
|
1706
|
-
* Marks all notifications in a repository as "read"
|
|
2077
|
+
* Marks all notifications in a repository as "read" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.
|
|
1707
2078
|
*/
|
|
1708
2079
|
markRepoNotificationsAsRead: {
|
|
1709
2080
|
(params?: RestEndpointMethodTypes["activity"]["markRepoNotificationsAsRead"]["parameters"]): Promise<RestEndpointMethodTypes["activity"]["markRepoNotificationsAsRead"]["response"]>;
|
|
@@ -1712,6 +2083,9 @@ export declare type RestEndpointMethods = {
|
|
|
1712
2083
|
url: string;
|
|
1713
2084
|
}>;
|
|
1714
2085
|
};
|
|
2086
|
+
/**
|
|
2087
|
+
* Marks a thread as "read." Marking a thread as "read" is equivalent to clicking a notification in your notification inbox on GitHub: https://github.com/notifications.
|
|
2088
|
+
*/
|
|
1715
2089
|
markThreadAsRead: {
|
|
1716
2090
|
(params?: RestEndpointMethodTypes["activity"]["markThreadAsRead"]["parameters"]): Promise<RestEndpointMethodTypes["activity"]["markThreadAsRead"]["response"]>;
|
|
1717
2091
|
defaults: RequestInterface["defaults"];
|
|
@@ -1788,7 +2162,7 @@ export declare type RestEndpointMethods = {
|
|
|
1788
2162
|
}>;
|
|
1789
2163
|
};
|
|
1790
2164
|
/**
|
|
1791
|
-
* OAuth applications can use
|
|
2165
|
+
* OAuth applications and GitHub applications with OAuth authorizations can use this API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) to use this endpoint, where the username is the application `client_id` and the password is its `client_secret`. Invalid tokens will return `404 NOT FOUND`.
|
|
1792
2166
|
*/
|
|
1793
2167
|
checkToken: {
|
|
1794
2168
|
(params?: RestEndpointMethodTypes["apps"]["checkToken"]["parameters"]): Promise<RestEndpointMethodTypes["apps"]["checkToken"]["response"]>;
|
|
@@ -1820,8 +2194,8 @@ export declare type RestEndpointMethods = {
|
|
|
1820
2194
|
}>;
|
|
1821
2195
|
};
|
|
1822
2196
|
/**
|
|
1823
|
-
* OAuth application owners can revoke a grant for their
|
|
1824
|
-
* Deleting an
|
|
2197
|
+
* OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted.
|
|
2198
|
+
* Deleting an application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized).
|
|
1825
2199
|
*/
|
|
1826
2200
|
deleteAuthorization: {
|
|
1827
2201
|
(params?: RestEndpointMethodTypes["apps"]["deleteAuthorization"]["parameters"]): Promise<RestEndpointMethodTypes["apps"]["deleteAuthorization"]["response"]>;
|
|
@@ -1843,7 +2217,7 @@ export declare type RestEndpointMethods = {
|
|
|
1843
2217
|
}>;
|
|
1844
2218
|
};
|
|
1845
2219
|
/**
|
|
1846
|
-
* OAuth application owners can revoke a single token for an OAuth application. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the
|
|
2220
|
+
* OAuth or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the application's `client_id` and `client_secret` as the username and password.
|
|
1847
2221
|
*/
|
|
1848
2222
|
deleteToken: {
|
|
1849
2223
|
(params?: RestEndpointMethodTypes["apps"]["deleteToken"]["parameters"]): Promise<RestEndpointMethodTypes["apps"]["deleteToken"]["response"]>;
|
|
@@ -2012,6 +2386,16 @@ export declare type RestEndpointMethods = {
|
|
|
2012
2386
|
url: string;
|
|
2013
2387
|
}>;
|
|
2014
2388
|
};
|
|
2389
|
+
/**
|
|
2390
|
+
* Lists all the pending installation requests for the authenticated GitHub App.
|
|
2391
|
+
*/
|
|
2392
|
+
listInstallationRequestsForAuthenticatedApp: {
|
|
2393
|
+
(params?: RestEndpointMethodTypes["apps"]["listInstallationRequestsForAuthenticatedApp"]["parameters"]): Promise<RestEndpointMethodTypes["apps"]["listInstallationRequestsForAuthenticatedApp"]["response"]>;
|
|
2394
|
+
defaults: RequestInterface["defaults"];
|
|
2395
|
+
endpoint: EndpointInterface<{
|
|
2396
|
+
url: string;
|
|
2397
|
+
}>;
|
|
2398
|
+
};
|
|
2015
2399
|
/**
|
|
2016
2400
|
* You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.
|
|
2017
2401
|
*
|
|
@@ -2146,7 +2530,7 @@ export declare type RestEndpointMethods = {
|
|
|
2146
2530
|
}>;
|
|
2147
2531
|
};
|
|
2148
2532
|
/**
|
|
2149
|
-
* OAuth applications can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the
|
|
2533
|
+
* OAuth applications and GitHub applications with OAuth authorizations can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`.
|
|
2150
2534
|
*/
|
|
2151
2535
|
resetToken: {
|
|
2152
2536
|
(params?: RestEndpointMethodTypes["apps"]["resetToken"]["parameters"]): Promise<RestEndpointMethodTypes["apps"]["resetToken"]["response"]>;
|
|
@@ -2170,7 +2554,7 @@ export declare type RestEndpointMethods = {
|
|
|
2170
2554
|
}>;
|
|
2171
2555
|
};
|
|
2172
2556
|
/**
|
|
2173
|
-
* Use a non-scoped user-to-server
|
|
2557
|
+
* Use a non-scoped user-to-server access token to create a repository scoped and/or permission scoped user-to-server access token. You can specify which repositories the token can access and which permissions are granted to the token. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the `client_id` and `client_secret` of the GitHub App as the username and password. Invalid tokens will return `404 NOT FOUND`.
|
|
2174
2558
|
*/
|
|
2175
2559
|
scopeToken: {
|
|
2176
2560
|
(params?: RestEndpointMethodTypes["apps"]["scopeToken"]["parameters"]): Promise<RestEndpointMethodTypes["apps"]["scopeToken"]["response"]>;
|
|
@@ -2207,69 +2591,39 @@ export declare type RestEndpointMethods = {
|
|
|
2207
2591
|
* Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)."
|
|
2208
2592
|
*
|
|
2209
2593
|
* You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.
|
|
2210
|
-
*/
|
|
2211
|
-
updateWebhookConfigForApp: {
|
|
2212
|
-
(params?: RestEndpointMethodTypes["apps"]["updateWebhookConfigForApp"]["parameters"]): Promise<RestEndpointMethodTypes["apps"]["updateWebhookConfigForApp"]["response"]>;
|
|
2213
|
-
defaults: RequestInterface["defaults"];
|
|
2214
|
-
endpoint: EndpointInterface<{
|
|
2215
|
-
url: string;
|
|
2216
|
-
}>;
|
|
2217
|
-
};
|
|
2218
|
-
};
|
|
2219
|
-
billing: {
|
|
2220
|
-
/**
|
|
2221
|
-
* Gets the summary of the free and paid GitHub Actions minutes used.
|
|
2222
|
-
*
|
|
2223
|
-
* Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)".
|
|
2224
|
-
*
|
|
2225
|
-
* Access tokens must have the `repo` or `admin:org` scope.
|
|
2226
|
-
*/
|
|
2227
|
-
getGithubActionsBillingOrg: {
|
|
2228
|
-
(params?: RestEndpointMethodTypes["billing"]["getGithubActionsBillingOrg"]["parameters"]): Promise<RestEndpointMethodTypes["billing"]["getGithubActionsBillingOrg"]["response"]>;
|
|
2229
|
-
defaults: RequestInterface["defaults"];
|
|
2230
|
-
endpoint: EndpointInterface<{
|
|
2231
|
-
url: string;
|
|
2232
|
-
}>;
|
|
2233
|
-
};
|
|
2234
|
-
/**
|
|
2235
|
-
* Gets the summary of the free and paid GitHub Actions minutes used.
|
|
2236
|
-
*
|
|
2237
|
-
* Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)".
|
|
2238
|
-
*
|
|
2239
|
-
* Access tokens must have the `user` scope.
|
|
2240
|
-
*/
|
|
2241
|
-
getGithubActionsBillingUser: {
|
|
2242
|
-
(params?: RestEndpointMethodTypes["billing"]["getGithubActionsBillingUser"]["parameters"]): Promise<RestEndpointMethodTypes["billing"]["getGithubActionsBillingUser"]["response"]>;
|
|
2594
|
+
*/
|
|
2595
|
+
updateWebhookConfigForApp: {
|
|
2596
|
+
(params?: RestEndpointMethodTypes["apps"]["updateWebhookConfigForApp"]["parameters"]): Promise<RestEndpointMethodTypes["apps"]["updateWebhookConfigForApp"]["response"]>;
|
|
2243
2597
|
defaults: RequestInterface["defaults"];
|
|
2244
2598
|
endpoint: EndpointInterface<{
|
|
2245
2599
|
url: string;
|
|
2246
2600
|
}>;
|
|
2247
2601
|
};
|
|
2602
|
+
};
|
|
2603
|
+
billing: {
|
|
2248
2604
|
/**
|
|
2249
|
-
* Gets the
|
|
2605
|
+
* Gets the summary of the free and paid GitHub Actions minutes used.
|
|
2250
2606
|
*
|
|
2251
|
-
*
|
|
2607
|
+
* Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)".
|
|
2252
2608
|
*
|
|
2253
|
-
*
|
|
2609
|
+
* Access tokens must have the `repo` or `admin:org` scope.
|
|
2254
2610
|
*/
|
|
2255
|
-
|
|
2256
|
-
(params?: RestEndpointMethodTypes["billing"]["
|
|
2611
|
+
getGithubActionsBillingOrg: {
|
|
2612
|
+
(params?: RestEndpointMethodTypes["billing"]["getGithubActionsBillingOrg"]["parameters"]): Promise<RestEndpointMethodTypes["billing"]["getGithubActionsBillingOrg"]["response"]>;
|
|
2257
2613
|
defaults: RequestInterface["defaults"];
|
|
2258
2614
|
endpoint: EndpointInterface<{
|
|
2259
2615
|
url: string;
|
|
2260
2616
|
}>;
|
|
2261
2617
|
};
|
|
2262
2618
|
/**
|
|
2263
|
-
* Gets the
|
|
2264
|
-
*
|
|
2265
|
-
* Each distinct user login across all repositories is counted as a single Advanced Security seat, so the `total_advanced_security_committers` is not the sum of advanced_security_committers for each repository.
|
|
2619
|
+
* Gets the summary of the free and paid GitHub Actions minutes used.
|
|
2266
2620
|
*
|
|
2267
|
-
*
|
|
2621
|
+
* Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)".
|
|
2268
2622
|
*
|
|
2269
|
-
*
|
|
2623
|
+
* Access tokens must have the `user` scope.
|
|
2270
2624
|
*/
|
|
2271
|
-
|
|
2272
|
-
(params?: RestEndpointMethodTypes["billing"]["
|
|
2625
|
+
getGithubActionsBillingUser: {
|
|
2626
|
+
(params?: RestEndpointMethodTypes["billing"]["getGithubActionsBillingUser"]["parameters"]): Promise<RestEndpointMethodTypes["billing"]["getGithubActionsBillingUser"]["response"]>;
|
|
2273
2627
|
defaults: RequestInterface["defaults"];
|
|
2274
2628
|
endpoint: EndpointInterface<{
|
|
2275
2629
|
url: string;
|
|
@@ -2553,9 +2907,6 @@ export declare type RestEndpointMethods = {
|
|
|
2553
2907
|
};
|
|
2554
2908
|
/**
|
|
2555
2909
|
* Gets a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint with private repos, the `public_repo` scope also grants permission to read security events on public repos only. GitHub Apps must have the `security_events` read permission to use this endpoint.
|
|
2556
|
-
*
|
|
2557
|
-
* **Deprecation notice**:
|
|
2558
|
-
* The instances field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The same information can now be retrieved via a GET request to the URL specified by `instances_url`.
|
|
2559
2910
|
*/
|
|
2560
2911
|
getAlert: {
|
|
2561
2912
|
(params?: RestEndpointMethodTypes["codeScanning"]["getAlert"]["parameters"]): Promise<RestEndpointMethodTypes["codeScanning"]["getAlert"]["response"]>;
|
|
@@ -2612,6 +2963,18 @@ export declare type RestEndpointMethods = {
|
|
|
2612
2963
|
url: string;
|
|
2613
2964
|
}>;
|
|
2614
2965
|
};
|
|
2966
|
+
/**
|
|
2967
|
+
* Gets a code scanning default setup configuration.
|
|
2968
|
+
* You must use an access token with the `repo` scope to use this endpoint with private repos or the `public_repo`
|
|
2969
|
+
* scope for public repos. GitHub Apps must have the `repo` write permission to use this endpoint.
|
|
2970
|
+
*/
|
|
2971
|
+
getDefaultSetup: {
|
|
2972
|
+
(params?: RestEndpointMethodTypes["codeScanning"]["getDefaultSetup"]["parameters"]): Promise<RestEndpointMethodTypes["codeScanning"]["getDefaultSetup"]["response"]>;
|
|
2973
|
+
defaults: RequestInterface["defaults"];
|
|
2974
|
+
endpoint: EndpointInterface<{
|
|
2975
|
+
url: string;
|
|
2976
|
+
}>;
|
|
2977
|
+
};
|
|
2615
2978
|
/**
|
|
2616
2979
|
* Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see "[Get a code scanning analysis for a repository](/rest/reference/code-scanning#get-a-code-scanning-analysis-for-a-repository)." You must use an access token with the `security_events` scope to use this endpoint with private repos, the `public_repo` scope also grants permission to read security events on public repos only. GitHub Apps must have the `security_events` read permission to use this endpoint.
|
|
2617
2980
|
*/
|
|
@@ -2635,19 +2998,6 @@ export declare type RestEndpointMethods = {
|
|
|
2635
2998
|
url: string;
|
|
2636
2999
|
}>;
|
|
2637
3000
|
};
|
|
2638
|
-
/**
|
|
2639
|
-
* Lists code scanning alerts for the default branch for all eligible repositories in an enterprise. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)."
|
|
2640
|
-
*
|
|
2641
|
-
* To use this endpoint, you must be a member of the enterprise,
|
|
2642
|
-
* and you must use an access token with the `repo` scope or `security_events` scope.
|
|
2643
|
-
*/
|
|
2644
|
-
listAlertsForEnterprise: {
|
|
2645
|
-
(params?: RestEndpointMethodTypes["codeScanning"]["listAlertsForEnterprise"]["parameters"]): Promise<RestEndpointMethodTypes["codeScanning"]["listAlertsForEnterprise"]["response"]>;
|
|
2646
|
-
defaults: RequestInterface["defaults"];
|
|
2647
|
-
endpoint: EndpointInterface<{
|
|
2648
|
-
url: string;
|
|
2649
|
-
}>;
|
|
2650
|
-
};
|
|
2651
3001
|
/**
|
|
2652
3002
|
* Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)."
|
|
2653
3003
|
*
|
|
@@ -2747,6 +3097,18 @@ export declare type RestEndpointMethods = {
|
|
|
2747
3097
|
url: string;
|
|
2748
3098
|
}>;
|
|
2749
3099
|
};
|
|
3100
|
+
/**
|
|
3101
|
+
* Updates a code scanning default setup configuration.
|
|
3102
|
+
* You must use an access token with the `repo` scope to use this endpoint with private repos or the `public_repo`
|
|
3103
|
+
* scope for public repos. GitHub Apps must have the `repo` write permission to use this endpoint.
|
|
3104
|
+
*/
|
|
3105
|
+
updateDefaultSetup: {
|
|
3106
|
+
(params?: RestEndpointMethodTypes["codeScanning"]["updateDefaultSetup"]["parameters"]): Promise<RestEndpointMethodTypes["codeScanning"]["updateDefaultSetup"]["response"]>;
|
|
3107
|
+
defaults: RequestInterface["defaults"];
|
|
3108
|
+
endpoint: EndpointInterface<{
|
|
3109
|
+
url: string;
|
|
3110
|
+
}>;
|
|
3111
|
+
};
|
|
2750
3112
|
/**
|
|
2751
3113
|
* Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint for private repositories. You can also use tokens with the `public_repo` scope for public repositories only. GitHub Apps must have the `security_events` write permission to use this endpoint.
|
|
2752
3114
|
*
|
|
@@ -2759,11 +3121,24 @@ export declare type RestEndpointMethods = {
|
|
|
2759
3121
|
* ```
|
|
2760
3122
|
* gzip -c analysis-data.sarif | base64 -w0
|
|
2761
3123
|
* ```
|
|
3124
|
+
* <br>
|
|
3125
|
+
* SARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable.
|
|
3126
|
+
* To get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries.
|
|
3127
|
+
*
|
|
2762
3128
|
*
|
|
2763
|
-
*
|
|
3129
|
+
* | **SARIF data** | **Maximum values** | **Additional limits** |
|
|
3130
|
+
* |----------------------------------|:------------------:|----------------------------------------------------------------------------------|
|
|
3131
|
+
* | Runs per file | 20 | |
|
|
3132
|
+
* | Results per run | 25,000 | Only the top 5,000 results will be included, prioritized by severity. |
|
|
3133
|
+
* | Rules per run | 25,000 | |
|
|
3134
|
+
* | Tool extensions per run | 100 | |
|
|
3135
|
+
* | Thread Flow Locations per result | 10,000 | Only the top 1,000 Thread Flow Locations will be included, using prioritization. |
|
|
3136
|
+
* | Location per result | 1,000 | Only 100 locations will be included. |
|
|
3137
|
+
* | Tags per rule | 20 | Only 10 tags will be included. |
|
|
2764
3138
|
*
|
|
2765
|
-
*
|
|
2766
|
-
*
|
|
3139
|
+
*
|
|
3140
|
+
* The `202 Accepted` response includes an `id` value.
|
|
3141
|
+
* You can use this ID to check the status of the upload by using it in the `/sarifs/{sarif_id}` endpoint.
|
|
2767
3142
|
* For more information, see "[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload)."
|
|
2768
3143
|
*/
|
|
2769
3144
|
uploadSarif: {
|
|
@@ -2853,26 +3228,23 @@ export declare type RestEndpointMethods = {
|
|
|
2853
3228
|
* Encrypt your secret using the [libsodium-wrappers](https://www.npmjs.com/package/libsodium-wrappers) library.
|
|
2854
3229
|
*
|
|
2855
3230
|
* ```
|
|
2856
|
-
*
|
|
2857
|
-
* const
|
|
2858
|
-
* const
|
|
2859
|
-
* const key = 'base64-encoded-public-key' // replace with the Base64 encoded public key.
|
|
3231
|
+
* const sodium = require('libsodium-wrappers')
|
|
3232
|
+
* const secret = 'plain-text-secret' // replace with the secret you want to encrypt
|
|
3233
|
+
* const key = 'base64-encoded-public-key' // replace with the Base64 encoded public key
|
|
2860
3234
|
*
|
|
2861
3235
|
* //Check if libsodium is ready and then proceed.
|
|
3236
|
+
* sodium.ready.then(() => {
|
|
3237
|
+
* // Convert Secret & Base64 key to Uint8Array.
|
|
3238
|
+
* let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)
|
|
3239
|
+
* let binsec = sodium.from_string(secret)
|
|
2862
3240
|
*
|
|
2863
|
-
*
|
|
2864
|
-
*
|
|
2865
|
-
* // Convert Secret & Base64 key to Uint8Array.
|
|
2866
|
-
* let binkey= sodium.from_base64(key, sodium.base64_variants.ORIGINAL) //Equivalent of Buffer.from(key, 'base64')
|
|
2867
|
-
* let binsec= sodium.from_string(secret) // Equivalent of Buffer.from(secret)
|
|
3241
|
+
* //Encrypt the secret using LibSodium
|
|
3242
|
+
* let encBytes = sodium.crypto_box_seal(binsec, binkey)
|
|
2868
3243
|
*
|
|
2869
|
-
*
|
|
2870
|
-
*
|
|
3244
|
+
* // Convert encrypted Uint8Array to Base64
|
|
3245
|
+
* let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)
|
|
2871
3246
|
*
|
|
2872
|
-
*
|
|
2873
|
-
* let output=sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL) //Equivalent of Buffer.from(encBytes).toString('base64')
|
|
2874
|
-
*
|
|
2875
|
-
* console.log(output)
|
|
3247
|
+
* console.log(output)
|
|
2876
3248
|
* });
|
|
2877
3249
|
* ```
|
|
2878
3250
|
*
|
|
@@ -2933,33 +3305,34 @@ export declare type RestEndpointMethods = {
|
|
|
2933
3305
|
/**
|
|
2934
3306
|
* Creates or updates a repository secret with an encrypted value. Encrypt your secret using
|
|
2935
3307
|
* [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access
|
|
2936
|
-
* token with the `repo` scope to use this endpoint. GitHub Apps must have the `codespaces_secrets`
|
|
2937
|
-
* permission to use this endpoint.
|
|
3308
|
+
* token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets`
|
|
3309
|
+
* repository permission to use this endpoint.
|
|
2938
3310
|
*
|
|
2939
3311
|
* #### Example of encrypting a secret using Node.js
|
|
2940
3312
|
*
|
|
2941
|
-
* Encrypt your secret using the [
|
|
3313
|
+
* Encrypt your secret using the [libsodium-wrappers](https://www.npmjs.com/package/libsodium-wrappers) library.
|
|
2942
3314
|
*
|
|
2943
3315
|
* ```
|
|
2944
|
-
* const sodium = require('
|
|
2945
|
-
*
|
|
2946
|
-
* const key =
|
|
2947
|
-
* const value = "plain-text-secret";
|
|
3316
|
+
* const sodium = require('libsodium-wrappers')
|
|
3317
|
+
* const secret = 'plain-text-secret' // replace with the secret you want to encrypt
|
|
3318
|
+
* const key = 'base64-encoded-public-key' // replace with the Base64 encoded public key
|
|
2948
3319
|
*
|
|
2949
|
-
* //
|
|
2950
|
-
*
|
|
2951
|
-
*
|
|
3320
|
+
* //Check if libsodium is ready and then proceed.
|
|
3321
|
+
* sodium.ready.then(() => {
|
|
3322
|
+
* // Convert Secret & Base64 key to Uint8Array.
|
|
3323
|
+
* let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)
|
|
3324
|
+
* let binsec = sodium.from_string(secret)
|
|
2952
3325
|
*
|
|
2953
|
-
*
|
|
2954
|
-
*
|
|
3326
|
+
* //Encrypt the secret using LibSodium
|
|
3327
|
+
* let encBytes = sodium.crypto_box_seal(binsec, binkey)
|
|
2955
3328
|
*
|
|
2956
|
-
*
|
|
2957
|
-
*
|
|
3329
|
+
* // Convert encrypted Uint8Array to Base64
|
|
3330
|
+
* let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)
|
|
2958
3331
|
*
|
|
2959
|
-
*
|
|
3332
|
+
* console.log(output)
|
|
3333
|
+
* });
|
|
2960
3334
|
* ```
|
|
2961
3335
|
*
|
|
2962
|
-
*
|
|
2963
3336
|
* #### Example of encrypting a secret using Python
|
|
2964
3337
|
*
|
|
2965
3338
|
* Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3.
|
|
@@ -3020,32 +3393,33 @@ export declare type RestEndpointMethods = {
|
|
|
3020
3393
|
*
|
|
3021
3394
|
* You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must also have Codespaces access to use this endpoint.
|
|
3022
3395
|
*
|
|
3023
|
-
* GitHub Apps must have
|
|
3396
|
+
* GitHub Apps must have write access to the `codespaces_user_secrets` user permission and `codespaces_secrets` repository permission on all referenced repositories to use this endpoint.
|
|
3024
3397
|
*
|
|
3025
3398
|
* #### Example encrypting a secret using Node.js
|
|
3026
3399
|
*
|
|
3027
|
-
* Encrypt your secret using the [
|
|
3400
|
+
* Encrypt your secret using the [libsodium-wrappers](https://www.npmjs.com/package/libsodium-wrappers) library.
|
|
3028
3401
|
*
|
|
3029
3402
|
* ```
|
|
3030
|
-
* const sodium = require('
|
|
3031
|
-
*
|
|
3032
|
-
* const key =
|
|
3033
|
-
* const value = "plain-text-secret";
|
|
3403
|
+
* const sodium = require('libsodium-wrappers')
|
|
3404
|
+
* const secret = 'plain-text-secret' // replace with the secret you want to encrypt
|
|
3405
|
+
* const key = 'base64-encoded-public-key' // replace with the Base64 encoded public key
|
|
3034
3406
|
*
|
|
3035
|
-
* //
|
|
3036
|
-
*
|
|
3037
|
-
*
|
|
3407
|
+
* //Check if libsodium is ready and then proceed.
|
|
3408
|
+
* sodium.ready.then(() => {
|
|
3409
|
+
* // Convert Secret & Base64 key to Uint8Array.
|
|
3410
|
+
* let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)
|
|
3411
|
+
* let binsec = sodium.from_string(secret)
|
|
3038
3412
|
*
|
|
3039
|
-
*
|
|
3040
|
-
*
|
|
3413
|
+
* //Encrypt the secret using LibSodium
|
|
3414
|
+
* let encBytes = sodium.crypto_box_seal(binsec, binkey)
|
|
3041
3415
|
*
|
|
3042
|
-
*
|
|
3043
|
-
*
|
|
3416
|
+
* // Convert encrypted Uint8Array to Base64
|
|
3417
|
+
* let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)
|
|
3044
3418
|
*
|
|
3045
|
-
*
|
|
3419
|
+
* console.log(output)
|
|
3420
|
+
* });
|
|
3046
3421
|
* ```
|
|
3047
3422
|
*
|
|
3048
|
-
*
|
|
3049
3423
|
* #### Example encrypting a secret using Python
|
|
3050
3424
|
*
|
|
3051
3425
|
* Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3.
|
|
@@ -3128,6 +3502,17 @@ export declare type RestEndpointMethods = {
|
|
|
3128
3502
|
url: string;
|
|
3129
3503
|
}>;
|
|
3130
3504
|
};
|
|
3505
|
+
/**
|
|
3506
|
+
* Codespaces for the specified users will no longer be billed to the organization.
|
|
3507
|
+
* To use this endpoint, the billing settings for the organization must be set to `selected_members`. For information on how to change this setting please see [these docs].(https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces) You must authenticate using an access token with the `admin:org` scope to use this endpoint.
|
|
3508
|
+
*/
|
|
3509
|
+
deleteCodespacesBillingUsers: {
|
|
3510
|
+
(params?: RestEndpointMethodTypes["codespaces"]["deleteCodespacesBillingUsers"]["parameters"]): Promise<RestEndpointMethodTypes["codespaces"]["deleteCodespacesBillingUsers"]["response"]>;
|
|
3511
|
+
defaults: RequestInterface["defaults"];
|
|
3512
|
+
endpoint: EndpointInterface<{
|
|
3513
|
+
url: string;
|
|
3514
|
+
}>;
|
|
3515
|
+
};
|
|
3131
3516
|
/**
|
|
3132
3517
|
* Deletes a user's codespace.
|
|
3133
3518
|
*
|
|
@@ -3165,7 +3550,7 @@ export declare type RestEndpointMethods = {
|
|
|
3165
3550
|
}>;
|
|
3166
3551
|
};
|
|
3167
3552
|
/**
|
|
3168
|
-
* Deletes a secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `codespaces_secrets` repository permission to use this endpoint.
|
|
3553
|
+
* Deletes a secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint.
|
|
3169
3554
|
*/
|
|
3170
3555
|
deleteRepoSecret: {
|
|
3171
3556
|
(params?: RestEndpointMethodTypes["codespaces"]["deleteRepoSecret"]["parameters"]): Promise<RestEndpointMethodTypes["codespaces"]["deleteRepoSecret"]["response"]>;
|
|
@@ -3191,6 +3576,8 @@ export declare type RestEndpointMethods = {
|
|
|
3191
3576
|
/**
|
|
3192
3577
|
* Triggers an export of the specified codespace and returns a URL and ID where the status of the export can be monitored.
|
|
3193
3578
|
*
|
|
3579
|
+
* If changes cannot be pushed to the codespace's repository, they will be pushed to a new or previously-existing fork instead.
|
|
3580
|
+
*
|
|
3194
3581
|
* You must authenticate using a personal access token with the `codespace` scope to use this endpoint.
|
|
3195
3582
|
*
|
|
3196
3583
|
* GitHub Apps must have write access to the `codespaces_lifecycle_admin` repository permission to use this endpoint.
|
|
@@ -3202,6 +3589,18 @@ export declare type RestEndpointMethods = {
|
|
|
3202
3589
|
url: string;
|
|
3203
3590
|
}>;
|
|
3204
3591
|
};
|
|
3592
|
+
/**
|
|
3593
|
+
* Lists the codespaces that a member of an organization has for repositories in that organization.
|
|
3594
|
+
*
|
|
3595
|
+
* You must authenticate using an access token with the `admin:org` scope to use this endpoint.
|
|
3596
|
+
*/
|
|
3597
|
+
getCodespacesForUserInOrg: {
|
|
3598
|
+
(params?: RestEndpointMethodTypes["codespaces"]["getCodespacesForUserInOrg"]["parameters"]): Promise<RestEndpointMethodTypes["codespaces"]["getCodespacesForUserInOrg"]["response"]>;
|
|
3599
|
+
defaults: RequestInterface["defaults"];
|
|
3600
|
+
endpoint: EndpointInterface<{
|
|
3601
|
+
url: string;
|
|
3602
|
+
}>;
|
|
3603
|
+
};
|
|
3205
3604
|
/**
|
|
3206
3605
|
* Gets information about an export of a codespace.
|
|
3207
3606
|
*
|
|
@@ -3266,7 +3665,7 @@ export declare type RestEndpointMethods = {
|
|
|
3266
3665
|
}>;
|
|
3267
3666
|
};
|
|
3268
3667
|
/**
|
|
3269
|
-
* Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `codespaces_secrets` repository permission to use this endpoint.
|
|
3668
|
+
* Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint.
|
|
3270
3669
|
*/
|
|
3271
3670
|
getRepoPublicKey: {
|
|
3272
3671
|
(params?: RestEndpointMethodTypes["codespaces"]["getRepoPublicKey"]["parameters"]): Promise<RestEndpointMethodTypes["codespaces"]["getRepoPublicKey"]["response"]>;
|
|
@@ -3276,7 +3675,7 @@ export declare type RestEndpointMethods = {
|
|
|
3276
3675
|
}>;
|
|
3277
3676
|
};
|
|
3278
3677
|
/**
|
|
3279
|
-
* Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `codespaces_secrets` repository permission to use this endpoint.
|
|
3678
|
+
* Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint.
|
|
3280
3679
|
*/
|
|
3281
3680
|
getRepoSecret: {
|
|
3282
3681
|
(params?: RestEndpointMethodTypes["codespaces"]["getRepoSecret"]["parameters"]): Promise<RestEndpointMethodTypes["codespaces"]["getRepoSecret"]["response"]>;
|
|
@@ -3366,7 +3765,7 @@ export declare type RestEndpointMethods = {
|
|
|
3366
3765
|
}>;
|
|
3367
3766
|
};
|
|
3368
3767
|
/**
|
|
3369
|
-
* Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `codespaces_secrets` repository permission to use this endpoint.
|
|
3768
|
+
* Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint.
|
|
3370
3769
|
*/
|
|
3371
3770
|
listRepoSecrets: {
|
|
3372
3771
|
(params?: RestEndpointMethodTypes["codespaces"]["listRepoSecrets"]["parameters"]): Promise<RestEndpointMethodTypes["codespaces"]["listRepoSecrets"]["response"]>;
|
|
@@ -3428,6 +3827,24 @@ export declare type RestEndpointMethods = {
|
|
|
3428
3827
|
url: string;
|
|
3429
3828
|
}>;
|
|
3430
3829
|
};
|
|
3830
|
+
/**
|
|
3831
|
+
* Publishes an unpublished codespace, creating a new repository and assigning it to the codespace.
|
|
3832
|
+
*
|
|
3833
|
+
* The codespace's token is granted write permissions to the repository, allowing the user to push their changes.
|
|
3834
|
+
*
|
|
3835
|
+
* This will fail for a codespace that is already published, meaning it has an associated repository.
|
|
3836
|
+
*
|
|
3837
|
+
* You must authenticate using a personal access token with the `codespace` scope to use this endpoint.
|
|
3838
|
+
*
|
|
3839
|
+
* GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint.
|
|
3840
|
+
*/
|
|
3841
|
+
publishForAuthenticatedUser: {
|
|
3842
|
+
(params?: RestEndpointMethodTypes["codespaces"]["publishForAuthenticatedUser"]["parameters"]): Promise<RestEndpointMethodTypes["codespaces"]["publishForAuthenticatedUser"]["response"]>;
|
|
3843
|
+
defaults: RequestInterface["defaults"];
|
|
3844
|
+
endpoint: EndpointInterface<{
|
|
3845
|
+
url: string;
|
|
3846
|
+
}>;
|
|
3847
|
+
};
|
|
3431
3848
|
/**
|
|
3432
3849
|
* Removes a repository from the selected repositories for a user's codespace secret.
|
|
3433
3850
|
* You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint.
|
|
@@ -3464,6 +3881,28 @@ export declare type RestEndpointMethods = {
|
|
|
3464
3881
|
url: string;
|
|
3465
3882
|
}>;
|
|
3466
3883
|
};
|
|
3884
|
+
/**
|
|
3885
|
+
* Sets which users can access codespaces in an organization. This is synonymous with granting or revoking codespaces billing permissions for users according to the visibility.
|
|
3886
|
+
* You must authenticate using an access token with the `admin:org` scope to use this endpoint.
|
|
3887
|
+
*/
|
|
3888
|
+
setCodespacesBilling: {
|
|
3889
|
+
(params?: RestEndpointMethodTypes["codespaces"]["setCodespacesBilling"]["parameters"]): Promise<RestEndpointMethodTypes["codespaces"]["setCodespacesBilling"]["response"]>;
|
|
3890
|
+
defaults: RequestInterface["defaults"];
|
|
3891
|
+
endpoint: EndpointInterface<{
|
|
3892
|
+
url: string;
|
|
3893
|
+
}>;
|
|
3894
|
+
};
|
|
3895
|
+
/**
|
|
3896
|
+
* Codespaces for the specified users will be billed to the organization.
|
|
3897
|
+
* To use this endpoint, the billing settings for the organization must be set to `selected_members`. For information on how to change this setting please see [these docs].(https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces) You must authenticate using an access token with the `admin:org` scope to use this endpoint.
|
|
3898
|
+
*/
|
|
3899
|
+
setCodespacesBillingUsers: {
|
|
3900
|
+
(params?: RestEndpointMethodTypes["codespaces"]["setCodespacesBillingUsers"]["parameters"]): Promise<RestEndpointMethodTypes["codespaces"]["setCodespacesBillingUsers"]["response"]>;
|
|
3901
|
+
defaults: RequestInterface["defaults"];
|
|
3902
|
+
endpoint: EndpointInterface<{
|
|
3903
|
+
url: string;
|
|
3904
|
+
}>;
|
|
3905
|
+
};
|
|
3467
3906
|
/**
|
|
3468
3907
|
* Select the repositories that will use a user's codespace secret.
|
|
3469
3908
|
*
|
|
@@ -3648,28 +4087,29 @@ export declare type RestEndpointMethods = {
|
|
|
3648
4087
|
*
|
|
3649
4088
|
* #### Example encrypting a secret using Node.js
|
|
3650
4089
|
*
|
|
3651
|
-
* Encrypt your secret using the [
|
|
4090
|
+
* Encrypt your secret using the [libsodium-wrappers](https://www.npmjs.com/package/libsodium-wrappers) library.
|
|
3652
4091
|
*
|
|
3653
4092
|
* ```
|
|
3654
|
-
* const sodium = require('
|
|
4093
|
+
* const sodium = require('libsodium-wrappers')
|
|
4094
|
+
* const secret = 'plain-text-secret' // replace with the secret you want to encrypt
|
|
4095
|
+
* const key = 'base64-encoded-public-key' // replace with the Base64 encoded public key
|
|
3655
4096
|
*
|
|
3656
|
-
*
|
|
3657
|
-
*
|
|
3658
|
-
*
|
|
3659
|
-
*
|
|
3660
|
-
*
|
|
3661
|
-
* const keyBytes = Buffer.from(key, 'base64');
|
|
4097
|
+
* //Check if libsodium is ready and then proceed.
|
|
4098
|
+
* sodium.ready.then(() => {
|
|
4099
|
+
* // Convert Secret & Base64 key to Uint8Array.
|
|
4100
|
+
* let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)
|
|
4101
|
+
* let binsec = sodium.from_string(secret)
|
|
3662
4102
|
*
|
|
3663
|
-
*
|
|
3664
|
-
*
|
|
4103
|
+
* //Encrypt the secret using LibSodium
|
|
4104
|
+
* let encBytes = sodium.crypto_box_seal(binsec, binkey)
|
|
3665
4105
|
*
|
|
3666
|
-
*
|
|
3667
|
-
*
|
|
4106
|
+
* // Convert encrypted Uint8Array to Base64
|
|
4107
|
+
* let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)
|
|
3668
4108
|
*
|
|
3669
|
-
*
|
|
4109
|
+
* console.log(output)
|
|
4110
|
+
* });
|
|
3670
4111
|
* ```
|
|
3671
4112
|
*
|
|
3672
|
-
*
|
|
3673
4113
|
* #### Example encrypting a secret using Python
|
|
3674
4114
|
*
|
|
3675
4115
|
* Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3.
|
|
@@ -3747,340 +4187,197 @@ export declare type RestEndpointMethods = {
|
|
|
3747
4187
|
/**
|
|
3748
4188
|
* You must use an access token with the `security_events` scope to use this endpoint with private repositories.
|
|
3749
4189
|
* You can also use tokens with the `public_repo` scope for public repositories only.
|
|
3750
|
-
* GitHub Apps must have **Dependabot alerts** read permission to use this endpoint.
|
|
3751
|
-
*/
|
|
3752
|
-
getAlert: {
|
|
3753
|
-
(params?: RestEndpointMethodTypes["dependabot"]["getAlert"]["parameters"]): Promise<RestEndpointMethodTypes["dependabot"]["getAlert"]["response"]>;
|
|
3754
|
-
defaults: RequestInterface["defaults"];
|
|
3755
|
-
endpoint: EndpointInterface<{
|
|
3756
|
-
url: string;
|
|
3757
|
-
}>;
|
|
3758
|
-
};
|
|
3759
|
-
/**
|
|
3760
|
-
* Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint.
|
|
3761
|
-
*/
|
|
3762
|
-
getOrgPublicKey: {
|
|
3763
|
-
(params?: RestEndpointMethodTypes["dependabot"]["getOrgPublicKey"]["parameters"]): Promise<RestEndpointMethodTypes["dependabot"]["getOrgPublicKey"]["response"]>;
|
|
3764
|
-
defaults: RequestInterface["defaults"];
|
|
3765
|
-
endpoint: EndpointInterface<{
|
|
3766
|
-
url: string;
|
|
3767
|
-
}>;
|
|
3768
|
-
};
|
|
3769
|
-
/**
|
|
3770
|
-
* Gets a single organization secret without revealing its encrypted value. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint.
|
|
3771
|
-
*/
|
|
3772
|
-
getOrgSecret: {
|
|
3773
|
-
(params?: RestEndpointMethodTypes["dependabot"]["getOrgSecret"]["parameters"]): Promise<RestEndpointMethodTypes["dependabot"]["getOrgSecret"]["response"]>;
|
|
3774
|
-
defaults: RequestInterface["defaults"];
|
|
3775
|
-
endpoint: EndpointInterface<{
|
|
3776
|
-
url: string;
|
|
3777
|
-
}>;
|
|
3778
|
-
};
|
|
3779
|
-
/**
|
|
3780
|
-
* Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint.
|
|
3781
|
-
*/
|
|
3782
|
-
getRepoPublicKey: {
|
|
3783
|
-
(params?: RestEndpointMethodTypes["dependabot"]["getRepoPublicKey"]["parameters"]): Promise<RestEndpointMethodTypes["dependabot"]["getRepoPublicKey"]["response"]>;
|
|
3784
|
-
defaults: RequestInterface["defaults"];
|
|
3785
|
-
endpoint: EndpointInterface<{
|
|
3786
|
-
url: string;
|
|
3787
|
-
}>;
|
|
3788
|
-
};
|
|
3789
|
-
/**
|
|
3790
|
-
* Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint.
|
|
3791
|
-
*/
|
|
3792
|
-
getRepoSecret: {
|
|
3793
|
-
(params?: RestEndpointMethodTypes["dependabot"]["getRepoSecret"]["parameters"]): Promise<RestEndpointMethodTypes["dependabot"]["getRepoSecret"]["response"]>;
|
|
3794
|
-
defaults: RequestInterface["defaults"];
|
|
3795
|
-
endpoint: EndpointInterface<{
|
|
3796
|
-
url: string;
|
|
3797
|
-
}>;
|
|
3798
|
-
};
|
|
3799
|
-
/**
|
|
3800
|
-
* You must use an access token with the `security_events` scope to use this endpoint with private repositories.
|
|
3801
|
-
* You can also use tokens with the `public_repo` scope for public repositories only.
|
|
3802
|
-
* GitHub Apps must have **Dependabot alerts** read permission to use this endpoint.
|
|
3803
|
-
*/
|
|
3804
|
-
listAlertsForRepo: {
|
|
3805
|
-
(params?: RestEndpointMethodTypes["dependabot"]["listAlertsForRepo"]["parameters"]): Promise<RestEndpointMethodTypes["dependabot"]["listAlertsForRepo"]["response"]>;
|
|
3806
|
-
defaults: RequestInterface["defaults"];
|
|
3807
|
-
endpoint: EndpointInterface<{
|
|
3808
|
-
url: string;
|
|
3809
|
-
}>;
|
|
3810
|
-
};
|
|
3811
|
-
/**
|
|
3812
|
-
* Lists all secrets available in an organization without revealing their encrypted values. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint.
|
|
3813
|
-
*/
|
|
3814
|
-
listOrgSecrets: {
|
|
3815
|
-
(params?: RestEndpointMethodTypes["dependabot"]["listOrgSecrets"]["parameters"]): Promise<RestEndpointMethodTypes["dependabot"]["listOrgSecrets"]["response"]>;
|
|
3816
|
-
defaults: RequestInterface["defaults"];
|
|
3817
|
-
endpoint: EndpointInterface<{
|
|
3818
|
-
url: string;
|
|
3819
|
-
}>;
|
|
3820
|
-
};
|
|
3821
|
-
/**
|
|
3822
|
-
* Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint.
|
|
3823
|
-
*/
|
|
3824
|
-
listRepoSecrets: {
|
|
3825
|
-
(params?: RestEndpointMethodTypes["dependabot"]["listRepoSecrets"]["parameters"]): Promise<RestEndpointMethodTypes["dependabot"]["listRepoSecrets"]["response"]>;
|
|
3826
|
-
defaults: RequestInterface["defaults"];
|
|
3827
|
-
endpoint: EndpointInterface<{
|
|
3828
|
-
url: string;
|
|
3829
|
-
}>;
|
|
3830
|
-
};
|
|
3831
|
-
/**
|
|
3832
|
-
* Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint.
|
|
3833
|
-
*/
|
|
3834
|
-
listSelectedReposForOrgSecret: {
|
|
3835
|
-
(params?: RestEndpointMethodTypes["dependabot"]["listSelectedReposForOrgSecret"]["parameters"]): Promise<RestEndpointMethodTypes["dependabot"]["listSelectedReposForOrgSecret"]["response"]>;
|
|
3836
|
-
defaults: RequestInterface["defaults"];
|
|
3837
|
-
endpoint: EndpointInterface<{
|
|
3838
|
-
url: string;
|
|
3839
|
-
}>;
|
|
3840
|
-
};
|
|
3841
|
-
/**
|
|
3842
|
-
* Removes a repository from an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/dependabot#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint.
|
|
3843
|
-
*/
|
|
3844
|
-
removeSelectedRepoFromOrgSecret: {
|
|
3845
|
-
(params?: RestEndpointMethodTypes["dependabot"]["removeSelectedRepoFromOrgSecret"]["parameters"]): Promise<RestEndpointMethodTypes["dependabot"]["removeSelectedRepoFromOrgSecret"]["response"]>;
|
|
3846
|
-
defaults: RequestInterface["defaults"];
|
|
3847
|
-
endpoint: EndpointInterface<{
|
|
3848
|
-
url: string;
|
|
3849
|
-
}>;
|
|
3850
|
-
};
|
|
3851
|
-
/**
|
|
3852
|
-
* Replaces all repositories for an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/dependabot#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint.
|
|
3853
|
-
*/
|
|
3854
|
-
setSelectedReposForOrgSecret: {
|
|
3855
|
-
(params?: RestEndpointMethodTypes["dependabot"]["setSelectedReposForOrgSecret"]["parameters"]): Promise<RestEndpointMethodTypes["dependabot"]["setSelectedReposForOrgSecret"]["response"]>;
|
|
3856
|
-
defaults: RequestInterface["defaults"];
|
|
3857
|
-
endpoint: EndpointInterface<{
|
|
3858
|
-
url: string;
|
|
3859
|
-
}>;
|
|
3860
|
-
};
|
|
3861
|
-
/**
|
|
3862
|
-
* You must use an access token with the `security_events` scope to use this endpoint with private repositories.
|
|
3863
|
-
* You can also use tokens with the `public_repo` scope for public repositories only.
|
|
3864
|
-
* GitHub Apps must have **Dependabot alerts** write permission to use this endpoint.
|
|
4190
|
+
* GitHub Apps must have **Dependabot alerts** read permission to use this endpoint.
|
|
3865
4191
|
*/
|
|
3866
|
-
|
|
3867
|
-
(params?: RestEndpointMethodTypes["dependabot"]["
|
|
4192
|
+
getAlert: {
|
|
4193
|
+
(params?: RestEndpointMethodTypes["dependabot"]["getAlert"]["parameters"]): Promise<RestEndpointMethodTypes["dependabot"]["getAlert"]["response"]>;
|
|
3868
4194
|
defaults: RequestInterface["defaults"];
|
|
3869
4195
|
endpoint: EndpointInterface<{
|
|
3870
4196
|
url: string;
|
|
3871
4197
|
}>;
|
|
3872
4198
|
};
|
|
3873
|
-
};
|
|
3874
|
-
dependencyGraph: {
|
|
3875
4199
|
/**
|
|
3876
|
-
*
|
|
4200
|
+
* Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint.
|
|
3877
4201
|
*/
|
|
3878
|
-
|
|
3879
|
-
(params?: RestEndpointMethodTypes["
|
|
4202
|
+
getOrgPublicKey: {
|
|
4203
|
+
(params?: RestEndpointMethodTypes["dependabot"]["getOrgPublicKey"]["parameters"]): Promise<RestEndpointMethodTypes["dependabot"]["getOrgPublicKey"]["response"]>;
|
|
3880
4204
|
defaults: RequestInterface["defaults"];
|
|
3881
4205
|
endpoint: EndpointInterface<{
|
|
3882
4206
|
url: string;
|
|
3883
4207
|
}>;
|
|
3884
4208
|
};
|
|
3885
4209
|
/**
|
|
3886
|
-
* Gets
|
|
4210
|
+
* Gets a single organization secret without revealing its encrypted value. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint.
|
|
3887
4211
|
*/
|
|
3888
|
-
|
|
3889
|
-
(params?: RestEndpointMethodTypes["
|
|
4212
|
+
getOrgSecret: {
|
|
4213
|
+
(params?: RestEndpointMethodTypes["dependabot"]["getOrgSecret"]["parameters"]): Promise<RestEndpointMethodTypes["dependabot"]["getOrgSecret"]["response"]>;
|
|
3890
4214
|
defaults: RequestInterface["defaults"];
|
|
3891
4215
|
endpoint: EndpointInterface<{
|
|
3892
4216
|
url: string;
|
|
3893
4217
|
}>;
|
|
3894
4218
|
};
|
|
3895
|
-
};
|
|
3896
|
-
emojis: {
|
|
3897
4219
|
/**
|
|
3898
|
-
*
|
|
4220
|
+
* Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint.
|
|
3899
4221
|
*/
|
|
3900
|
-
|
|
3901
|
-
(params?: RestEndpointMethodTypes["
|
|
4222
|
+
getRepoPublicKey: {
|
|
4223
|
+
(params?: RestEndpointMethodTypes["dependabot"]["getRepoPublicKey"]["parameters"]): Promise<RestEndpointMethodTypes["dependabot"]["getRepoPublicKey"]["response"]>;
|
|
3902
4224
|
defaults: RequestInterface["defaults"];
|
|
3903
4225
|
endpoint: EndpointInterface<{
|
|
3904
4226
|
url: string;
|
|
3905
4227
|
}>;
|
|
3906
4228
|
};
|
|
3907
|
-
};
|
|
3908
|
-
enterpriseAdmin: {
|
|
3909
4229
|
/**
|
|
3910
|
-
*
|
|
3911
|
-
*
|
|
3912
|
-
* You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.
|
|
4230
|
+
* Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint.
|
|
3913
4231
|
*/
|
|
3914
|
-
|
|
3915
|
-
(params?: RestEndpointMethodTypes["
|
|
4232
|
+
getRepoSecret: {
|
|
4233
|
+
(params?: RestEndpointMethodTypes["dependabot"]["getRepoSecret"]["parameters"]): Promise<RestEndpointMethodTypes["dependabot"]["getRepoSecret"]["response"]>;
|
|
3916
4234
|
defaults: RequestInterface["defaults"];
|
|
3917
4235
|
endpoint: EndpointInterface<{
|
|
3918
4236
|
url: string;
|
|
3919
4237
|
}>;
|
|
3920
4238
|
};
|
|
3921
4239
|
/**
|
|
3922
|
-
*
|
|
3923
|
-
*
|
|
3924
|
-
*
|
|
4240
|
+
* Lists Dependabot alerts for repositories that are owned by the specified enterprise.
|
|
4241
|
+
* To use this endpoint, you must be a member of the enterprise, and you must use an
|
|
4242
|
+
* access token with the `repo` scope or `security_events` scope.
|
|
4243
|
+
* Alerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager. For more information about security managers, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)."
|
|
3925
4244
|
*/
|
|
3926
|
-
|
|
3927
|
-
(params?: RestEndpointMethodTypes["
|
|
4245
|
+
listAlertsForEnterprise: {
|
|
4246
|
+
(params?: RestEndpointMethodTypes["dependabot"]["listAlertsForEnterprise"]["parameters"]): Promise<RestEndpointMethodTypes["dependabot"]["listAlertsForEnterprise"]["response"]>;
|
|
3928
4247
|
defaults: RequestInterface["defaults"];
|
|
3929
4248
|
endpoint: EndpointInterface<{
|
|
3930
4249
|
url: string;
|
|
3931
4250
|
}>;
|
|
3932
4251
|
};
|
|
3933
4252
|
/**
|
|
3934
|
-
*
|
|
4253
|
+
* Lists Dependabot alerts for an organization.
|
|
4254
|
+
*
|
|
4255
|
+
* To use this endpoint, you must be an owner or security manager for the organization, and you must use an access token with the `repo` scope or `security_events` scope.
|
|
4256
|
+
*
|
|
4257
|
+
* For public repositories, you may instead use the `public_repo` scope.
|
|
3935
4258
|
*
|
|
3936
|
-
*
|
|
4259
|
+
* GitHub Apps must have **Dependabot alerts** read permission to use this endpoint.
|
|
3937
4260
|
*/
|
|
3938
|
-
|
|
3939
|
-
(params?: RestEndpointMethodTypes["
|
|
4261
|
+
listAlertsForOrg: {
|
|
4262
|
+
(params?: RestEndpointMethodTypes["dependabot"]["listAlertsForOrg"]["parameters"]): Promise<RestEndpointMethodTypes["dependabot"]["listAlertsForOrg"]["response"]>;
|
|
3940
4263
|
defaults: RequestInterface["defaults"];
|
|
3941
4264
|
endpoint: EndpointInterface<{
|
|
3942
4265
|
url: string;
|
|
3943
4266
|
}>;
|
|
3944
4267
|
};
|
|
3945
4268
|
/**
|
|
3946
|
-
*
|
|
3947
|
-
*
|
|
3948
|
-
*
|
|
4269
|
+
* You must use an access token with the `security_events` scope to use this endpoint with private repositories.
|
|
4270
|
+
* You can also use tokens with the `public_repo` scope for public repositories only.
|
|
4271
|
+
* GitHub Apps must have **Dependabot alerts** read permission to use this endpoint.
|
|
3949
4272
|
*/
|
|
3950
|
-
|
|
3951
|
-
(params?: RestEndpointMethodTypes["
|
|
4273
|
+
listAlertsForRepo: {
|
|
4274
|
+
(params?: RestEndpointMethodTypes["dependabot"]["listAlertsForRepo"]["parameters"]): Promise<RestEndpointMethodTypes["dependabot"]["listAlertsForRepo"]["response"]>;
|
|
3952
4275
|
defaults: RequestInterface["defaults"];
|
|
3953
4276
|
endpoint: EndpointInterface<{
|
|
3954
4277
|
url: string;
|
|
3955
4278
|
}>;
|
|
3956
4279
|
};
|
|
3957
4280
|
/**
|
|
3958
|
-
*
|
|
3959
|
-
*
|
|
3960
|
-
* You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.
|
|
4281
|
+
* Lists all secrets available in an organization without revealing their encrypted values. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint.
|
|
3961
4282
|
*/
|
|
3962
|
-
|
|
3963
|
-
(params?: RestEndpointMethodTypes["
|
|
4283
|
+
listOrgSecrets: {
|
|
4284
|
+
(params?: RestEndpointMethodTypes["dependabot"]["listOrgSecrets"]["parameters"]): Promise<RestEndpointMethodTypes["dependabot"]["listOrgSecrets"]["response"]>;
|
|
3964
4285
|
defaults: RequestInterface["defaults"];
|
|
3965
4286
|
endpoint: EndpointInterface<{
|
|
3966
4287
|
url: string;
|
|
3967
4288
|
}>;
|
|
3968
4289
|
};
|
|
3969
4290
|
/**
|
|
3970
|
-
*
|
|
3971
|
-
*
|
|
3972
|
-
* To use this endpoint, your GitHub Enterprise Server instance must be connected to GitHub Enterprise Cloud using GitHub Connect. You must enable Server Statistics, and for the API request provide your enterprise account name or organization name connected to the GitHub Enterprise Server. For more information, see "[Enabling Server Statistics for your enterprise](/admin/configuration/configuring-github-connect/enabling-server-statistics-for-your-enterprise)" in the GitHub Enterprise Server documentation.
|
|
3973
|
-
*
|
|
3974
|
-
* You'll need to use a personal access token:
|
|
3975
|
-
* - If you connected your GitHub Enterprise Server to an enterprise account and enabled Server Statistics, you'll need a personal access token with the `read:enterprise` permission.
|
|
3976
|
-
* - If you connected your GitHub Enterprise Server to an organization account and enabled Server Statistics, you'll need a personal access token with the `read:org` permission.
|
|
3977
|
-
*
|
|
3978
|
-
* For more information on creating a personal access token, see "[Creating a personal access token](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)."
|
|
4291
|
+
* Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint.
|
|
3979
4292
|
*/
|
|
3980
|
-
|
|
3981
|
-
(params?: RestEndpointMethodTypes["
|
|
4293
|
+
listRepoSecrets: {
|
|
4294
|
+
(params?: RestEndpointMethodTypes["dependabot"]["listRepoSecrets"]["parameters"]): Promise<RestEndpointMethodTypes["dependabot"]["listRepoSecrets"]["response"]>;
|
|
3982
4295
|
defaults: RequestInterface["defaults"];
|
|
3983
4296
|
endpoint: EndpointInterface<{
|
|
3984
4297
|
url: string;
|
|
3985
4298
|
}>;
|
|
3986
4299
|
};
|
|
3987
4300
|
/**
|
|
3988
|
-
* Lists all
|
|
3989
|
-
*
|
|
3990
|
-
* You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.
|
|
4301
|
+
* Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint.
|
|
3991
4302
|
*/
|
|
3992
|
-
|
|
3993
|
-
(params?: RestEndpointMethodTypes["
|
|
4303
|
+
listSelectedReposForOrgSecret: {
|
|
4304
|
+
(params?: RestEndpointMethodTypes["dependabot"]["listSelectedReposForOrgSecret"]["parameters"]): Promise<RestEndpointMethodTypes["dependabot"]["listSelectedReposForOrgSecret"]["response"]>;
|
|
3994
4305
|
defaults: RequestInterface["defaults"];
|
|
3995
4306
|
endpoint: EndpointInterface<{
|
|
3996
4307
|
url: string;
|
|
3997
4308
|
}>;
|
|
3998
4309
|
};
|
|
3999
4310
|
/**
|
|
4000
|
-
*
|
|
4001
|
-
*
|
|
4002
|
-
* You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.
|
|
4311
|
+
* Removes a repository from an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/dependabot#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint.
|
|
4003
4312
|
*/
|
|
4004
|
-
|
|
4005
|
-
(params?: RestEndpointMethodTypes["
|
|
4313
|
+
removeSelectedRepoFromOrgSecret: {
|
|
4314
|
+
(params?: RestEndpointMethodTypes["dependabot"]["removeSelectedRepoFromOrgSecret"]["parameters"]): Promise<RestEndpointMethodTypes["dependabot"]["removeSelectedRepoFromOrgSecret"]["response"]>;
|
|
4006
4315
|
defaults: RequestInterface["defaults"];
|
|
4007
4316
|
endpoint: EndpointInterface<{
|
|
4008
4317
|
url: string;
|
|
4009
4318
|
}>;
|
|
4010
4319
|
};
|
|
4011
4320
|
/**
|
|
4012
|
-
*
|
|
4013
|
-
* enterprise. Returns the remaining read-only labels from the runner.
|
|
4014
|
-
*
|
|
4015
|
-
* You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.
|
|
4321
|
+
* Replaces all repositories for an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/dependabot#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint.
|
|
4016
4322
|
*/
|
|
4017
|
-
|
|
4018
|
-
(params?: RestEndpointMethodTypes["
|
|
4323
|
+
setSelectedReposForOrgSecret: {
|
|
4324
|
+
(params?: RestEndpointMethodTypes["dependabot"]["setSelectedReposForOrgSecret"]["parameters"]): Promise<RestEndpointMethodTypes["dependabot"]["setSelectedReposForOrgSecret"]["response"]>;
|
|
4019
4325
|
defaults: RequestInterface["defaults"];
|
|
4020
4326
|
endpoint: EndpointInterface<{
|
|
4021
4327
|
url: string;
|
|
4022
4328
|
}>;
|
|
4023
4329
|
};
|
|
4024
4330
|
/**
|
|
4025
|
-
*
|
|
4026
|
-
*
|
|
4027
|
-
*
|
|
4028
|
-
* This endpoint returns a `404 Not Found` status if the custom label is not
|
|
4029
|
-
* present on the runner.
|
|
4030
|
-
*
|
|
4031
|
-
* You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.
|
|
4331
|
+
* You must use an access token with the `security_events` scope to use this endpoint with private repositories.
|
|
4332
|
+
* You can also use tokens with the `public_repo` scope for public repositories only.
|
|
4333
|
+
* GitHub Apps must have **Dependabot alerts** write permission to use this endpoint.
|
|
4032
4334
|
*/
|
|
4033
|
-
|
|
4034
|
-
(params?: RestEndpointMethodTypes["
|
|
4335
|
+
updateAlert: {
|
|
4336
|
+
(params?: RestEndpointMethodTypes["dependabot"]["updateAlert"]["parameters"]): Promise<RestEndpointMethodTypes["dependabot"]["updateAlert"]["response"]>;
|
|
4035
4337
|
defaults: RequestInterface["defaults"];
|
|
4036
4338
|
endpoint: EndpointInterface<{
|
|
4037
4339
|
url: string;
|
|
4038
4340
|
}>;
|
|
4039
4341
|
};
|
|
4342
|
+
};
|
|
4343
|
+
dependencyGraph: {
|
|
4040
4344
|
/**
|
|
4041
|
-
*
|
|
4042
|
-
*
|
|
4043
|
-
* You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.
|
|
4345
|
+
* Create a new snapshot of a repository's dependencies. You must authenticate using an access token with the `repo` scope to use this endpoint for a repository that the requesting user has access to.
|
|
4044
4346
|
*/
|
|
4045
|
-
|
|
4046
|
-
(params?: RestEndpointMethodTypes["
|
|
4347
|
+
createRepositorySnapshot: {
|
|
4348
|
+
(params?: RestEndpointMethodTypes["dependencyGraph"]["createRepositorySnapshot"]["parameters"]): Promise<RestEndpointMethodTypes["dependencyGraph"]["createRepositorySnapshot"]["response"]>;
|
|
4047
4349
|
defaults: RequestInterface["defaults"];
|
|
4048
4350
|
endpoint: EndpointInterface<{
|
|
4049
4351
|
url: string;
|
|
4050
4352
|
}>;
|
|
4051
4353
|
};
|
|
4052
4354
|
/**
|
|
4053
|
-
*
|
|
4054
|
-
* self-hosted runner configured in an enterprise.
|
|
4055
|
-
*
|
|
4056
|
-
* You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.
|
|
4355
|
+
* Gets the diff of the dependency changes between two commits of a repository, based on the changes to the dependency manifests made in those commits.
|
|
4057
4356
|
*/
|
|
4058
|
-
|
|
4059
|
-
(params?: RestEndpointMethodTypes["
|
|
4357
|
+
diffRange: {
|
|
4358
|
+
(params?: RestEndpointMethodTypes["dependencyGraph"]["diffRange"]["parameters"]): Promise<RestEndpointMethodTypes["dependencyGraph"]["diffRange"]["response"]>;
|
|
4060
4359
|
defaults: RequestInterface["defaults"];
|
|
4061
4360
|
endpoint: EndpointInterface<{
|
|
4062
4361
|
url: string;
|
|
4063
4362
|
}>;
|
|
4064
4363
|
};
|
|
4065
4364
|
/**
|
|
4066
|
-
*
|
|
4067
|
-
*
|
|
4068
|
-
* You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.
|
|
4365
|
+
* Exports the software bill of materials (SBOM) for a repository in SPDX JSON format.
|
|
4069
4366
|
*/
|
|
4070
|
-
|
|
4071
|
-
(params?: RestEndpointMethodTypes["
|
|
4367
|
+
exportSbom: {
|
|
4368
|
+
(params?: RestEndpointMethodTypes["dependencyGraph"]["exportSbom"]["parameters"]): Promise<RestEndpointMethodTypes["dependencyGraph"]["exportSbom"]["response"]>;
|
|
4072
4369
|
defaults: RequestInterface["defaults"];
|
|
4073
4370
|
endpoint: EndpointInterface<{
|
|
4074
4371
|
url: string;
|
|
4075
4372
|
}>;
|
|
4076
4373
|
};
|
|
4374
|
+
};
|
|
4375
|
+
emojis: {
|
|
4077
4376
|
/**
|
|
4078
|
-
*
|
|
4079
|
-
*
|
|
4080
|
-
* You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.
|
|
4377
|
+
* Lists all the emojis available to use on GitHub.
|
|
4081
4378
|
*/
|
|
4082
|
-
|
|
4083
|
-
(params?: RestEndpointMethodTypes["
|
|
4379
|
+
get: {
|
|
4380
|
+
(params?: RestEndpointMethodTypes["emojis"]["get"]["parameters"]): Promise<RestEndpointMethodTypes["emojis"]["get"]["response"]>;
|
|
4084
4381
|
defaults: RequestInterface["defaults"];
|
|
4085
4382
|
endpoint: EndpointInterface<{
|
|
4086
4383
|
url: string;
|
|
@@ -4237,7 +4534,7 @@ export declare type RestEndpointMethods = {
|
|
|
4237
4534
|
}>;
|
|
4238
4535
|
};
|
|
4239
4536
|
/**
|
|
4240
|
-
* Allows you to update
|
|
4537
|
+
* Allows you to update a gist's description and to update, delete, or rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged.
|
|
4241
4538
|
*/
|
|
4242
4539
|
update: {
|
|
4243
4540
|
(params?: RestEndpointMethodTypes["gists"]["update"]["parameters"]): Promise<RestEndpointMethodTypes["gists"]["update"]["response"]>;
|
|
@@ -4287,7 +4584,7 @@ export declare type RestEndpointMethods = {
|
|
|
4287
4584
|
* | `unsigned` | The object does not include a signature. |
|
|
4288
4585
|
* | `unknown_signature_type` | A non-PGP signature was found in the commit. |
|
|
4289
4586
|
* | `no_user` | No user was associated with the `committer` email address in the commit. |
|
|
4290
|
-
* | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on
|
|
4587
|
+
* | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |
|
|
4291
4588
|
* | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |
|
|
4292
4589
|
* | `unknown_key` | The key that made the signature has not been registered with any user's account. |
|
|
4293
4590
|
* | `malformed_signature` | There was an error parsing the signature. |
|
|
@@ -4336,7 +4633,7 @@ export declare type RestEndpointMethods = {
|
|
|
4336
4633
|
* | `unsigned` | The object does not include a signature. |
|
|
4337
4634
|
* | `unknown_signature_type` | A non-PGP signature was found in the commit. |
|
|
4338
4635
|
* | `no_user` | No user was associated with the `committer` email address in the commit. |
|
|
4339
|
-
* | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on
|
|
4636
|
+
* | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |
|
|
4340
4637
|
* | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |
|
|
4341
4638
|
* | `unknown_key` | The key that made the signature has not been registered with any user's account. |
|
|
4342
4639
|
* | `malformed_signature` | There was an error parsing the signature. |
|
|
@@ -4408,7 +4705,7 @@ export declare type RestEndpointMethods = {
|
|
|
4408
4705
|
* | `unsigned` | The object does not include a signature. |
|
|
4409
4706
|
* | `unknown_signature_type` | A non-PGP signature was found in the commit. |
|
|
4410
4707
|
* | `no_user` | No user was associated with the `committer` email address in the commit. |
|
|
4411
|
-
* | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on
|
|
4708
|
+
* | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |
|
|
4412
4709
|
* | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |
|
|
4413
4710
|
* | `unknown_key` | The key that made the signature has not been registered with any user's account. |
|
|
4414
4711
|
* | `malformed_signature` | There was an error parsing the signature. |
|
|
@@ -4457,7 +4754,7 @@ export declare type RestEndpointMethods = {
|
|
|
4457
4754
|
* | `unsigned` | The object does not include a signature. |
|
|
4458
4755
|
* | `unknown_signature_type` | A non-PGP signature was found in the commit. |
|
|
4459
4756
|
* | `no_user` | No user was associated with the `committer` email address in the commit. |
|
|
4460
|
-
* | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on
|
|
4757
|
+
* | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |
|
|
4461
4758
|
* | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |
|
|
4462
4759
|
* | `unknown_key` | The key that made the signature has not been registered with any user's account. |
|
|
4463
4760
|
* | `malformed_signature` | There was an error parsing the signature. |
|
|
@@ -4690,6 +4987,20 @@ export declare type RestEndpointMethods = {
|
|
|
4690
4987
|
url: string;
|
|
4691
4988
|
}>;
|
|
4692
4989
|
};
|
|
4990
|
+
/**
|
|
4991
|
+
* Checks if a user has permission to be assigned to a specific issue.
|
|
4992
|
+
*
|
|
4993
|
+
* If the `assignee` can be assigned to this issue, a `204` status code with no content is returned.
|
|
4994
|
+
*
|
|
4995
|
+
* Otherwise a `404` status code is returned.
|
|
4996
|
+
*/
|
|
4997
|
+
checkUserCanBeAssignedToIssue: {
|
|
4998
|
+
(params?: RestEndpointMethodTypes["issues"]["checkUserCanBeAssignedToIssue"]["parameters"]): Promise<RestEndpointMethodTypes["issues"]["checkUserCanBeAssignedToIssue"]["response"]>;
|
|
4999
|
+
defaults: RequestInterface["defaults"];
|
|
5000
|
+
endpoint: EndpointInterface<{
|
|
5001
|
+
url: string;
|
|
5002
|
+
}>;
|
|
5003
|
+
};
|
|
4693
5004
|
/**
|
|
4694
5005
|
* Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/articles/disabling-issues/), the API returns a `410 Gone` status.
|
|
4695
5006
|
*
|
|
@@ -4703,7 +5014,13 @@ export declare type RestEndpointMethods = {
|
|
|
4703
5014
|
}>;
|
|
4704
5015
|
};
|
|
4705
5016
|
/**
|
|
4706
|
-
*
|
|
5017
|
+
* You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.
|
|
5018
|
+
*
|
|
5019
|
+
* This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications).
|
|
5020
|
+
* Creating content too quickly using this endpoint may result in secondary rate limiting.
|
|
5021
|
+
* See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)"
|
|
5022
|
+
* and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)"
|
|
5023
|
+
* for details.
|
|
4707
5024
|
*/
|
|
4708
5025
|
createComment: {
|
|
4709
5026
|
(params?: RestEndpointMethodTypes["issues"]["createComment"]["parameters"]): Promise<RestEndpointMethodTypes["issues"]["createComment"]["response"]>;
|
|
@@ -4726,6 +5043,9 @@ export declare type RestEndpointMethods = {
|
|
|
4726
5043
|
url: string;
|
|
4727
5044
|
}>;
|
|
4728
5045
|
};
|
|
5046
|
+
/**
|
|
5047
|
+
* You can use the REST API to delete comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.
|
|
5048
|
+
*/
|
|
4729
5049
|
deleteComment: {
|
|
4730
5050
|
(params?: RestEndpointMethodTypes["issues"]["deleteComment"]["parameters"]): Promise<RestEndpointMethodTypes["issues"]["deleteComment"]["response"]>;
|
|
4731
5051
|
defaults: RequestInterface["defaults"];
|
|
@@ -4755,7 +5075,7 @@ export declare type RestEndpointMethods = {
|
|
|
4755
5075
|
* access, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe
|
|
4756
5076
|
* to the [`issues`](https://docs.github.com/webhooks/event-payloads/#issues) webhook.
|
|
4757
5077
|
*
|
|
4758
|
-
* **Note**: GitHub's REST API
|
|
5078
|
+
* **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this
|
|
4759
5079
|
* reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by
|
|
4760
5080
|
* the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull
|
|
4761
5081
|
* request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint.
|
|
@@ -4767,6 +5087,9 @@ export declare type RestEndpointMethods = {
|
|
|
4767
5087
|
url: string;
|
|
4768
5088
|
}>;
|
|
4769
5089
|
};
|
|
5090
|
+
/**
|
|
5091
|
+
* You can use the REST API to get comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.
|
|
5092
|
+
*/
|
|
4770
5093
|
getComment: {
|
|
4771
5094
|
(params?: RestEndpointMethodTypes["issues"]["getComment"]["parameters"]): Promise<RestEndpointMethodTypes["issues"]["getComment"]["response"]>;
|
|
4772
5095
|
defaults: RequestInterface["defaults"];
|
|
@@ -4801,7 +5124,7 @@ export declare type RestEndpointMethods = {
|
|
|
4801
5124
|
* necessarily assigned to you.
|
|
4802
5125
|
*
|
|
4803
5126
|
*
|
|
4804
|
-
* **Note**: GitHub's REST API
|
|
5127
|
+
* **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this
|
|
4805
5128
|
* reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by
|
|
4806
5129
|
* the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull
|
|
4807
5130
|
* request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint.
|
|
@@ -4824,7 +5147,9 @@ export declare type RestEndpointMethods = {
|
|
|
4824
5147
|
}>;
|
|
4825
5148
|
};
|
|
4826
5149
|
/**
|
|
4827
|
-
*
|
|
5150
|
+
* You can use the REST API to list comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.
|
|
5151
|
+
*
|
|
5152
|
+
* Issue comments are ordered by ascending ID.
|
|
4828
5153
|
*/
|
|
4829
5154
|
listComments: {
|
|
4830
5155
|
(params?: RestEndpointMethodTypes["issues"]["listComments"]["parameters"]): Promise<RestEndpointMethodTypes["issues"]["listComments"]["response"]>;
|
|
@@ -4834,7 +5159,9 @@ export declare type RestEndpointMethods = {
|
|
|
4834
5159
|
}>;
|
|
4835
5160
|
};
|
|
4836
5161
|
/**
|
|
4837
|
-
*
|
|
5162
|
+
* You can use the REST API to list comments on issues and pull requests for a repository. Every pull request is an issue, but not every issue is a pull request.
|
|
5163
|
+
*
|
|
5164
|
+
* By default, issue comments are ordered by ascending ID.
|
|
4838
5165
|
*/
|
|
4839
5166
|
listCommentsForRepo: {
|
|
4840
5167
|
(params?: RestEndpointMethodTypes["issues"]["listCommentsForRepo"]["parameters"]): Promise<RestEndpointMethodTypes["issues"]["listCommentsForRepo"]["response"]>;
|
|
@@ -4867,7 +5194,7 @@ export declare type RestEndpointMethods = {
|
|
|
4867
5194
|
/**
|
|
4868
5195
|
* List issues across owned and member repositories assigned to the authenticated user.
|
|
4869
5196
|
*
|
|
4870
|
-
* **Note**: GitHub's REST API
|
|
5197
|
+
* **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this
|
|
4871
5198
|
* reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by
|
|
4872
5199
|
* the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull
|
|
4873
5200
|
* request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint.
|
|
@@ -4882,7 +5209,7 @@ export declare type RestEndpointMethods = {
|
|
|
4882
5209
|
/**
|
|
4883
5210
|
* List issues in an organization assigned to the authenticated user.
|
|
4884
5211
|
*
|
|
4885
|
-
* **Note**: GitHub's REST API
|
|
5212
|
+
* **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this
|
|
4886
5213
|
* reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by
|
|
4887
5214
|
* the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull
|
|
4888
5215
|
* request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint.
|
|
@@ -4895,9 +5222,9 @@ export declare type RestEndpointMethods = {
|
|
|
4895
5222
|
}>;
|
|
4896
5223
|
};
|
|
4897
5224
|
/**
|
|
4898
|
-
* List issues in a repository.
|
|
5225
|
+
* List issues in a repository. Only open issues will be listed.
|
|
4899
5226
|
*
|
|
4900
|
-
* **Note**: GitHub's REST API
|
|
5227
|
+
* **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this
|
|
4901
5228
|
* reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by
|
|
4902
5229
|
* the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull
|
|
4903
5230
|
* request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint.
|
|
@@ -5006,6 +5333,9 @@ export declare type RestEndpointMethods = {
|
|
|
5006
5333
|
url: string;
|
|
5007
5334
|
}>;
|
|
5008
5335
|
};
|
|
5336
|
+
/**
|
|
5337
|
+
* You can use the REST API to update comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.
|
|
5338
|
+
*/
|
|
5009
5339
|
updateComment: {
|
|
5010
5340
|
(params?: RestEndpointMethodTypes["issues"]["updateComment"]["parameters"]): Promise<RestEndpointMethodTypes["issues"]["updateComment"]["response"]>;
|
|
5011
5341
|
defaults: RequestInterface["defaults"];
|
|
@@ -5079,7 +5409,9 @@ export declare type RestEndpointMethods = {
|
|
|
5079
5409
|
/**
|
|
5080
5410
|
* Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see "[About GitHub's IP addresses](https://docs.github.com/articles/about-github-s-ip-addresses/)."
|
|
5081
5411
|
*
|
|
5082
|
-
*
|
|
5412
|
+
* The values shown in the documentation's response are example values. You must always query the API directly to get the latest values.
|
|
5413
|
+
*
|
|
5414
|
+
* **Note:** This endpoint returns both IPv4 and IPv6 addresses. However, not all features support IPv6. You should refer to the specific documentation for each feature to determine if IPv6 is supported.
|
|
5083
5415
|
*/
|
|
5084
5416
|
get: {
|
|
5085
5417
|
(params?: RestEndpointMethodTypes["meta"]["get"]["parameters"]): Promise<RestEndpointMethodTypes["meta"]["get"]["response"]>;
|
|
@@ -5088,6 +5420,16 @@ export declare type RestEndpointMethods = {
|
|
|
5088
5420
|
url: string;
|
|
5089
5421
|
}>;
|
|
5090
5422
|
};
|
|
5423
|
+
/**
|
|
5424
|
+
* Get all supported GitHub API versions.
|
|
5425
|
+
*/
|
|
5426
|
+
getAllVersions: {
|
|
5427
|
+
(params?: RestEndpointMethodTypes["meta"]["getAllVersions"]["parameters"]): Promise<RestEndpointMethodTypes["meta"]["getAllVersions"]["response"]>;
|
|
5428
|
+
defaults: RequestInterface["defaults"];
|
|
5429
|
+
endpoint: EndpointInterface<{
|
|
5430
|
+
url: string;
|
|
5431
|
+
}>;
|
|
5432
|
+
};
|
|
5091
5433
|
/**
|
|
5092
5434
|
* Get the octocat as ASCII art
|
|
5093
5435
|
*/
|
|
@@ -5122,6 +5464,10 @@ export declare type RestEndpointMethods = {
|
|
|
5122
5464
|
migrations: {
|
|
5123
5465
|
/**
|
|
5124
5466
|
* Stop an import for a repository.
|
|
5467
|
+
*
|
|
5468
|
+
* **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end
|
|
5469
|
+
* on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update
|
|
5470
|
+
* these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API.
|
|
5125
5471
|
*/
|
|
5126
5472
|
cancelImport: {
|
|
5127
5473
|
(params?: RestEndpointMethodTypes["migrations"]["cancelImport"]["parameters"]): Promise<RestEndpointMethodTypes["migrations"]["cancelImport"]["response"]>;
|
|
@@ -5131,7 +5477,7 @@ export declare type RestEndpointMethods = {
|
|
|
5131
5477
|
}>;
|
|
5132
5478
|
};
|
|
5133
5479
|
/**
|
|
5134
|
-
* Deletes a previous migration archive. Downloadable migration archives are automatically deleted after seven days. Migration metadata, which is returned in the [List user migrations](https://docs.github.com/rest/
|
|
5480
|
+
* Deletes a previous migration archive. Downloadable migration archives are automatically deleted after seven days. Migration metadata, which is returned in the [List user migrations](https://docs.github.com/rest/migrations/users#list-user-migrations) and [Get a user migration status](https://docs.github.com/rest/migrations/users#get-a-user-migration-status) endpoints, will continue to be available even after an archive is deleted.
|
|
5135
5481
|
*/
|
|
5136
5482
|
deleteArchiveForAuthenticatedUser: {
|
|
5137
5483
|
(params?: RestEndpointMethodTypes["migrations"]["deleteArchiveForAuthenticatedUser"]["parameters"]): Promise<RestEndpointMethodTypes["migrations"]["deleteArchiveForAuthenticatedUser"]["response"]>;
|
|
@@ -5193,7 +5539,11 @@ export declare type RestEndpointMethods = {
|
|
|
5193
5539
|
/**
|
|
5194
5540
|
* Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username `hubot` into something like `hubot <hubot@12341234-abab-fefe-8787-fedcba987654>`.
|
|
5195
5541
|
*
|
|
5196
|
-
* This endpoint and the [Map a commit author](https://docs.github.com/rest/
|
|
5542
|
+
* This endpoint and the [Map a commit author](https://docs.github.com/rest/migrations/source-imports#map-a-commit-author) endpoint allow you to provide correct Git author information.
|
|
5543
|
+
*
|
|
5544
|
+
* **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end
|
|
5545
|
+
* on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update
|
|
5546
|
+
* these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API.
|
|
5197
5547
|
*/
|
|
5198
5548
|
getCommitAuthors: {
|
|
5199
5549
|
(params?: RestEndpointMethodTypes["migrations"]["getCommitAuthors"]["parameters"]): Promise<RestEndpointMethodTypes["migrations"]["getCommitAuthors"]["response"]>;
|
|
@@ -5205,6 +5555,10 @@ export declare type RestEndpointMethods = {
|
|
|
5205
5555
|
/**
|
|
5206
5556
|
* View the progress of an import.
|
|
5207
5557
|
*
|
|
5558
|
+
* **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end
|
|
5559
|
+
* on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update
|
|
5560
|
+
* these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API.
|
|
5561
|
+
*
|
|
5208
5562
|
* **Import status**
|
|
5209
5563
|
*
|
|
5210
5564
|
* This section includes details about the possible values of the `status` field of the Import Progress response.
|
|
@@ -5219,11 +5573,11 @@ export declare type RestEndpointMethods = {
|
|
|
5219
5573
|
*
|
|
5220
5574
|
* If there are problems, you will see one of these in the `status` field:
|
|
5221
5575
|
*
|
|
5222
|
-
* * `auth_failed` - the import requires authentication in order to connect to the original repository. To update authentication for the import, please see the [Update an import](https://docs.github.com/rest/
|
|
5576
|
+
* * `auth_failed` - the import requires authentication in order to connect to the original repository. To update authentication for the import, please see the [Update an import](https://docs.github.com/rest/migrations/source-imports#update-an-import) section.
|
|
5223
5577
|
* * `error` - the import encountered an error. The import progress response will include the `failed_step` and an error message. Contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api) for more information.
|
|
5224
|
-
* * `detection_needs_auth` - the importer requires authentication for the originating repository to continue detection. To update authentication for the import, please see the [Update an import](https://docs.github.com/rest/
|
|
5225
|
-
* * `detection_found_nothing` - the importer didn't recognize any source control at the URL. To resolve, [Cancel the import](https://docs.github.com/rest/
|
|
5226
|
-
* * `detection_found_multiple` - the importer found several projects or repositories at the provided URL. When this is the case, the Import Progress response will also include a `project_choices` field with the possible project choices as values. To update project choice, please see the [Update an import](https://docs.github.com/rest/
|
|
5578
|
+
* * `detection_needs_auth` - the importer requires authentication for the originating repository to continue detection. To update authentication for the import, please see the [Update an import](https://docs.github.com/rest/migrations/source-imports#update-an-import) section.
|
|
5579
|
+
* * `detection_found_nothing` - the importer didn't recognize any source control at the URL. To resolve, [Cancel the import](https://docs.github.com/rest/migrations/source-imports#cancel-an-import) and [retry](https://docs.github.com/rest/migrations/source-imports#start-an-import) with the correct URL.
|
|
5580
|
+
* * `detection_found_multiple` - the importer found several projects or repositories at the provided URL. When this is the case, the Import Progress response will also include a `project_choices` field with the possible project choices as values. To update project choice, please see the [Update an import](https://docs.github.com/rest/migrations/source-imports#update-an-import) section.
|
|
5227
5581
|
*
|
|
5228
5582
|
* **The project_choices field**
|
|
5229
5583
|
*
|
|
@@ -5247,6 +5601,10 @@ export declare type RestEndpointMethods = {
|
|
|
5247
5601
|
};
|
|
5248
5602
|
/**
|
|
5249
5603
|
* List files larger than 100MB found during the import
|
|
5604
|
+
*
|
|
5605
|
+
* **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end
|
|
5606
|
+
* on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update
|
|
5607
|
+
* these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API.
|
|
5250
5608
|
*/
|
|
5251
5609
|
getLargeFiles: {
|
|
5252
5610
|
(params?: RestEndpointMethodTypes["migrations"]["getLargeFiles"]["parameters"]): Promise<RestEndpointMethodTypes["migrations"]["getLargeFiles"]["response"]>;
|
|
@@ -5263,7 +5621,7 @@ export declare type RestEndpointMethods = {
|
|
|
5263
5621
|
* * `exported` - the migration finished successfully.
|
|
5264
5622
|
* * `failed` - the migration failed.
|
|
5265
5623
|
*
|
|
5266
|
-
* Once the migration has been `exported` you can [download the migration archive](https://docs.github.com/rest/
|
|
5624
|
+
* Once the migration has been `exported` you can [download the migration archive](https://docs.github.com/rest/migrations/users#download-a-user-migration-archive).
|
|
5267
5625
|
*/
|
|
5268
5626
|
getStatusForAuthenticatedUser: {
|
|
5269
5627
|
(params?: RestEndpointMethodTypes["migrations"]["getStatusForAuthenticatedUser"]["parameters"]): Promise<RestEndpointMethodTypes["migrations"]["getStatusForAuthenticatedUser"]["response"]>;
|
|
@@ -5300,7 +5658,9 @@ export declare type RestEndpointMethods = {
|
|
|
5300
5658
|
}>;
|
|
5301
5659
|
};
|
|
5302
5660
|
/**
|
|
5303
|
-
* Lists the most recent migrations.
|
|
5661
|
+
* Lists the most recent migrations, including both exports (which can be started through the REST API) and imports (which cannot be started using the REST API).
|
|
5662
|
+
*
|
|
5663
|
+
* A list of `repositories` is only returned for export migrations.
|
|
5304
5664
|
*/
|
|
5305
5665
|
listForOrg: {
|
|
5306
5666
|
(params?: RestEndpointMethodTypes["migrations"]["listForOrg"]["parameters"]): Promise<RestEndpointMethodTypes["migrations"]["listForOrg"]["response"]>;
|
|
@@ -5341,7 +5701,12 @@ export declare type RestEndpointMethods = {
|
|
|
5341
5701
|
}>;
|
|
5342
5702
|
};
|
|
5343
5703
|
/**
|
|
5344
|
-
* Update an author's identity for the import. Your application can continue updating authors any time before you push
|
|
5704
|
+
* Update an author's identity for the import. Your application can continue updating authors any time before you push
|
|
5705
|
+
* new commits to the repository.
|
|
5706
|
+
*
|
|
5707
|
+
* **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end
|
|
5708
|
+
* on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update
|
|
5709
|
+
* these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API.
|
|
5345
5710
|
*/
|
|
5346
5711
|
mapCommitAuthor: {
|
|
5347
5712
|
(params?: RestEndpointMethodTypes["migrations"]["mapCommitAuthor"]["parameters"]): Promise<RestEndpointMethodTypes["migrations"]["mapCommitAuthor"]["response"]>;
|
|
@@ -5351,7 +5716,15 @@ export declare type RestEndpointMethods = {
|
|
|
5351
5716
|
}>;
|
|
5352
5717
|
};
|
|
5353
5718
|
/**
|
|
5354
|
-
* You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability
|
|
5719
|
+
* You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability
|
|
5720
|
+
* is powered by [Git LFS](https://git-lfs.com).
|
|
5721
|
+
*
|
|
5722
|
+
* You can learn more about our LFS feature and working with large files [on our help
|
|
5723
|
+
* site](https://docs.github.com/repositories/working-with-files/managing-large-files).
|
|
5724
|
+
*
|
|
5725
|
+
* **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end
|
|
5726
|
+
* on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update
|
|
5727
|
+
* these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API.
|
|
5355
5728
|
*/
|
|
5356
5729
|
setLfsPreference: {
|
|
5357
5730
|
(params?: RestEndpointMethodTypes["migrations"]["setLfsPreference"]["parameters"]): Promise<RestEndpointMethodTypes["migrations"]["setLfsPreference"]["response"]>;
|
|
@@ -5381,7 +5754,8 @@ export declare type RestEndpointMethods = {
|
|
|
5381
5754
|
}>;
|
|
5382
5755
|
};
|
|
5383
5756
|
/**
|
|
5384
|
-
* Start a source import to a GitHub repository using GitHub Importer.
|
|
5757
|
+
* Start a source import to a GitHub repository using GitHub Importer. Importing into a GitHub repository with GitHub Actions enabled is not supported and will return a status `422 Unprocessable Entity` response.
|
|
5758
|
+
* **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API.
|
|
5385
5759
|
*/
|
|
5386
5760
|
startImport: {
|
|
5387
5761
|
(params?: RestEndpointMethodTypes["migrations"]["startImport"]["parameters"]): Promise<RestEndpointMethodTypes["migrations"]["startImport"]["response"]>;
|
|
@@ -5391,7 +5765,7 @@ export declare type RestEndpointMethods = {
|
|
|
5391
5765
|
}>;
|
|
5392
5766
|
};
|
|
5393
5767
|
/**
|
|
5394
|
-
* Unlocks a repository. You can lock repositories when you [start a user migration](https://docs.github.com/rest/
|
|
5768
|
+
* Unlocks a repository. You can lock repositories when you [start a user migration](https://docs.github.com/rest/migrations/users#start-a-user-migration). Once the migration is complete you can unlock each repository to begin using it again or [delete the repository](https://docs.github.com/rest/repos/repos#delete-a-repository) if you no longer need the source data. Returns a status of `404 Not Found` if the repository is not locked.
|
|
5395
5769
|
*/
|
|
5396
5770
|
unlockRepoForAuthenticatedUser: {
|
|
5397
5771
|
(params?: RestEndpointMethodTypes["migrations"]["unlockRepoForAuthenticatedUser"]["parameters"]): Promise<RestEndpointMethodTypes["migrations"]["unlockRepoForAuthenticatedUser"]["response"]>;
|
|
@@ -5401,7 +5775,7 @@ export declare type RestEndpointMethods = {
|
|
|
5401
5775
|
}>;
|
|
5402
5776
|
};
|
|
5403
5777
|
/**
|
|
5404
|
-
* Unlocks a repository that was locked for migration. You should unlock each migrated repository and [delete them](https://docs.github.com/rest/
|
|
5778
|
+
* Unlocks a repository that was locked for migration. You should unlock each migrated repository and [delete them](https://docs.github.com/rest/repos/repos#delete-a-repository) when the migration is complete and you no longer need the source data.
|
|
5405
5779
|
*/
|
|
5406
5780
|
unlockRepoForOrg: {
|
|
5407
5781
|
(params?: RestEndpointMethodTypes["migrations"]["unlockRepoForOrg"]["parameters"]): Promise<RestEndpointMethodTypes["migrations"]["unlockRepoForOrg"]["response"]>;
|
|
@@ -5417,6 +5791,10 @@ export declare type RestEndpointMethods = {
|
|
|
5417
5791
|
* Some servers (e.g. TFS servers) can have several projects at a single URL. In those cases the import progress will
|
|
5418
5792
|
* have the status `detection_found_multiple` and the Import Progress response will include a `project_choices` array.
|
|
5419
5793
|
* You can select the project to import by providing one of the objects in the `project_choices` array in the update request.
|
|
5794
|
+
*
|
|
5795
|
+
* **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end
|
|
5796
|
+
* on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update
|
|
5797
|
+
* these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API.
|
|
5420
5798
|
*/
|
|
5421
5799
|
updateImport: {
|
|
5422
5800
|
(params?: RestEndpointMethodTypes["migrations"]["updateImport"]["parameters"]): Promise<RestEndpointMethodTypes["migrations"]["updateImport"]["response"]>;
|
|
@@ -5451,7 +5829,7 @@ export declare type RestEndpointMethods = {
|
|
|
5451
5829
|
/**
|
|
5452
5830
|
* Cancel an organization invitation. In order to cancel an organization invitation, the authenticated user must be an organization owner.
|
|
5453
5831
|
*
|
|
5454
|
-
* This endpoint triggers [notifications](https://docs.github.com/
|
|
5832
|
+
* This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications).
|
|
5455
5833
|
*/
|
|
5456
5834
|
cancelInvitation: {
|
|
5457
5835
|
(params?: RestEndpointMethodTypes["orgs"]["cancelInvitation"]["parameters"]): Promise<RestEndpointMethodTypes["orgs"]["cancelInvitation"]["response"]>;
|
|
@@ -5485,7 +5863,7 @@ export declare type RestEndpointMethods = {
|
|
|
5485
5863
|
}>;
|
|
5486
5864
|
};
|
|
5487
5865
|
/**
|
|
5488
|
-
* When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see "[Converting an organization member to an outside collaborator](https://docs.github.com/articles/converting-an-organization-member-to-an-outside-collaborator/)". Converting an organization member to an outside collaborator may be restricted by enterprise administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/
|
|
5866
|
+
* When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see "[Converting an organization member to an outside collaborator](https://docs.github.com/articles/converting-an-organization-member-to-an-outside-collaborator/)". Converting an organization member to an outside collaborator may be restricted by enterprise administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)."
|
|
5489
5867
|
*/
|
|
5490
5868
|
convertMemberToOutsideCollaborator: {
|
|
5491
5869
|
(params?: RestEndpointMethodTypes["orgs"]["convertMemberToOutsideCollaborator"]["parameters"]): Promise<RestEndpointMethodTypes["orgs"]["convertMemberToOutsideCollaborator"]["response"]>;
|
|
@@ -5494,27 +5872,10 @@ export declare type RestEndpointMethods = {
|
|
|
5494
5872
|
url: string;
|
|
5495
5873
|
}>;
|
|
5496
5874
|
};
|
|
5497
|
-
/**
|
|
5498
|
-
* **Note**: This operation is in beta and is subject to change.
|
|
5499
|
-
*
|
|
5500
|
-
* Creates a custom repository role that can be used by all repositories owned by the organization.
|
|
5501
|
-
*
|
|
5502
|
-
* To use this endpoint the authenticated user must be an administrator for the organization and must use an access token with `admin:org` scope.
|
|
5503
|
-
* GitHub Apps must have the `organization_custom_roles:write` organization permission to use this endpoint.
|
|
5504
|
-
*
|
|
5505
|
-
* For more information on custom repository roles, see "[Managing custom repository roles for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)."
|
|
5506
|
-
*/
|
|
5507
|
-
createCustomRole: {
|
|
5508
|
-
(params?: RestEndpointMethodTypes["orgs"]["createCustomRole"]["parameters"]): Promise<RestEndpointMethodTypes["orgs"]["createCustomRole"]["response"]>;
|
|
5509
|
-
defaults: RequestInterface["defaults"];
|
|
5510
|
-
endpoint: EndpointInterface<{
|
|
5511
|
-
url: string;
|
|
5512
|
-
}>;
|
|
5513
|
-
};
|
|
5514
5875
|
/**
|
|
5515
5876
|
* Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner.
|
|
5516
5877
|
*
|
|
5517
|
-
* This endpoint triggers [notifications](https://docs.github.com/
|
|
5878
|
+
* This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details.
|
|
5518
5879
|
*/
|
|
5519
5880
|
createInvitation: {
|
|
5520
5881
|
(params?: RestEndpointMethodTypes["orgs"]["createInvitation"]["parameters"]): Promise<RestEndpointMethodTypes["orgs"]["createInvitation"]["response"]>;
|
|
@@ -5534,18 +5895,16 @@ export declare type RestEndpointMethods = {
|
|
|
5534
5895
|
}>;
|
|
5535
5896
|
};
|
|
5536
5897
|
/**
|
|
5537
|
-
*
|
|
5898
|
+
* Deletes an organization and all its repositories.
|
|
5538
5899
|
*
|
|
5539
|
-
*
|
|
5540
|
-
* user, team, or invitation with the deleted custom role will be reassigned the inherited role.
|
|
5900
|
+
* The organization login will be unavailable for 90 days after deletion.
|
|
5541
5901
|
*
|
|
5542
|
-
*
|
|
5543
|
-
* GitHub Apps must have the `organization_custom_roles:write` organization permission to use this endpoint.
|
|
5902
|
+
* Please review the Terms of Service regarding account deletion before using this endpoint:
|
|
5544
5903
|
*
|
|
5545
|
-
*
|
|
5904
|
+
* https://docs.github.com/site-policy/github-terms/github-terms-of-service
|
|
5546
5905
|
*/
|
|
5547
|
-
|
|
5548
|
-
(params?: RestEndpointMethodTypes["orgs"]["
|
|
5906
|
+
delete: {
|
|
5907
|
+
(params?: RestEndpointMethodTypes["orgs"]["delete"]["parameters"]): Promise<RestEndpointMethodTypes["orgs"]["delete"]["response"]>;
|
|
5549
5908
|
defaults: RequestInterface["defaults"];
|
|
5550
5909
|
endpoint: EndpointInterface<{
|
|
5551
5910
|
url: string;
|
|
@@ -5559,7 +5918,7 @@ export declare type RestEndpointMethods = {
|
|
|
5559
5918
|
}>;
|
|
5560
5919
|
};
|
|
5561
5920
|
/**
|
|
5562
|
-
* Enables or disables the specified security feature for all repositories in an organization.
|
|
5921
|
+
* Enables or disables the specified security feature for all eligible repositories in an organization.
|
|
5563
5922
|
*
|
|
5564
5923
|
* To use this endpoint, you must be an organization owner or be member of a team with the security manager role.
|
|
5565
5924
|
* A token with the 'write:org' scope is also required.
|
|
@@ -5639,7 +5998,7 @@ export declare type RestEndpointMethods = {
|
|
|
5639
5998
|
/**
|
|
5640
5999
|
* Lists all organizations, in the order that they were created on GitHub.
|
|
5641
6000
|
*
|
|
5642
|
-
* **Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/
|
|
6001
|
+
* **Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations.
|
|
5643
6002
|
*/
|
|
5644
6003
|
list: {
|
|
5645
6004
|
(params?: RestEndpointMethodTypes["orgs"]["list"]["parameters"]): Promise<RestEndpointMethodTypes["orgs"]["list"]["response"]>;
|
|
@@ -5668,22 +6027,6 @@ export declare type RestEndpointMethods = {
|
|
|
5668
6027
|
url: string;
|
|
5669
6028
|
}>;
|
|
5670
6029
|
};
|
|
5671
|
-
/**
|
|
5672
|
-
* List the custom repository roles available in this organization. In order to see custom
|
|
5673
|
-
* repository roles in an organization, the authenticated user must be an organization owner.
|
|
5674
|
-
*
|
|
5675
|
-
* To use this endpoint the authenticated user must be an administrator for the organization or of an repository of the organizaiton and must use an access token with `admin:org repo` scope.
|
|
5676
|
-
* GitHub Apps must have the `organization_custom_roles:read` organization permission to use this endpoint.
|
|
5677
|
-
*
|
|
5678
|
-
* For more information on custom repository roles, see "[Managing custom repository roles for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)".
|
|
5679
|
-
*/
|
|
5680
|
-
listCustomRoles: {
|
|
5681
|
-
(params?: RestEndpointMethodTypes["orgs"]["listCustomRoles"]["parameters"]): Promise<RestEndpointMethodTypes["orgs"]["listCustomRoles"]["response"]>;
|
|
5682
|
-
defaults: RequestInterface["defaults"];
|
|
5683
|
-
endpoint: EndpointInterface<{
|
|
5684
|
-
url: string;
|
|
5685
|
-
}>;
|
|
5686
|
-
};
|
|
5687
6030
|
/**
|
|
5688
6031
|
* The return hash contains `failed_at` and `failed_reason` fields which represent the time at which the invitation failed and the reason for the failure.
|
|
5689
6032
|
*/
|
|
@@ -5694,21 +6037,6 @@ export declare type RestEndpointMethods = {
|
|
|
5694
6037
|
url: string;
|
|
5695
6038
|
}>;
|
|
5696
6039
|
};
|
|
5697
|
-
/**
|
|
5698
|
-
* **Note**: This operation is in beta and subject to change.
|
|
5699
|
-
*
|
|
5700
|
-
* Lists the fine-grained permissions available for an organization.
|
|
5701
|
-
*
|
|
5702
|
-
* To use this endpoint the authenticated user must be an administrator for the organization or of an repository of the organizaiton and must use an access token with `admin:org repo` scope.
|
|
5703
|
-
* GitHub Apps must have the `organization_custom_roles:read` organization permission to use this endpoint.
|
|
5704
|
-
*/
|
|
5705
|
-
listFineGrainedPermissions: {
|
|
5706
|
-
(params?: RestEndpointMethodTypes["orgs"]["listFineGrainedPermissions"]["parameters"]): Promise<RestEndpointMethodTypes["orgs"]["listFineGrainedPermissions"]["response"]>;
|
|
5707
|
-
defaults: RequestInterface["defaults"];
|
|
5708
|
-
endpoint: EndpointInterface<{
|
|
5709
|
-
url: string;
|
|
5710
|
-
}>;
|
|
5711
|
-
};
|
|
5712
6040
|
/**
|
|
5713
6041
|
* List organizations for the authenticated user.
|
|
5714
6042
|
*
|
|
@@ -5773,7 +6101,59 @@ export declare type RestEndpointMethods = {
|
|
|
5773
6101
|
}>;
|
|
5774
6102
|
};
|
|
5775
6103
|
/**
|
|
5776
|
-
*
|
|
6104
|
+
* Lists the repositories a fine-grained personal access token has access to. Only GitHub Apps can call this API,
|
|
6105
|
+
* using the `organization_personal_access_tokens: read` permission.
|
|
6106
|
+
*
|
|
6107
|
+
* **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.
|
|
6108
|
+
*/
|
|
6109
|
+
listPatGrantRepositories: {
|
|
6110
|
+
(params?: RestEndpointMethodTypes["orgs"]["listPatGrantRepositories"]["parameters"]): Promise<RestEndpointMethodTypes["orgs"]["listPatGrantRepositories"]["response"]>;
|
|
6111
|
+
defaults: RequestInterface["defaults"];
|
|
6112
|
+
endpoint: EndpointInterface<{
|
|
6113
|
+
url: string;
|
|
6114
|
+
}>;
|
|
6115
|
+
};
|
|
6116
|
+
/**
|
|
6117
|
+
* Lists the repositories a fine-grained personal access token request is requesting access to. Only GitHub Apps can call this API,
|
|
6118
|
+
* using the `organization_personal_access_token_requests: read` permission.
|
|
6119
|
+
*
|
|
6120
|
+
* **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.
|
|
6121
|
+
*/
|
|
6122
|
+
listPatGrantRequestRepositories: {
|
|
6123
|
+
(params?: RestEndpointMethodTypes["orgs"]["listPatGrantRequestRepositories"]["parameters"]): Promise<RestEndpointMethodTypes["orgs"]["listPatGrantRequestRepositories"]["response"]>;
|
|
6124
|
+
defaults: RequestInterface["defaults"];
|
|
6125
|
+
endpoint: EndpointInterface<{
|
|
6126
|
+
url: string;
|
|
6127
|
+
}>;
|
|
6128
|
+
};
|
|
6129
|
+
/**
|
|
6130
|
+
* Lists requests from organization members to access organization resources with a fine-grained personal access token. Only GitHub Apps can call this API,
|
|
6131
|
+
* using the `organization_personal_access_token_requests: read` permission.
|
|
6132
|
+
*
|
|
6133
|
+
* **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.
|
|
6134
|
+
*/
|
|
6135
|
+
listPatGrantRequests: {
|
|
6136
|
+
(params?: RestEndpointMethodTypes["orgs"]["listPatGrantRequests"]["parameters"]): Promise<RestEndpointMethodTypes["orgs"]["listPatGrantRequests"]["response"]>;
|
|
6137
|
+
defaults: RequestInterface["defaults"];
|
|
6138
|
+
endpoint: EndpointInterface<{
|
|
6139
|
+
url: string;
|
|
6140
|
+
}>;
|
|
6141
|
+
};
|
|
6142
|
+
/**
|
|
6143
|
+
* Lists approved fine-grained personal access tokens owned by organization members that can access organization resources. Only GitHub Apps can call this API,
|
|
6144
|
+
* using the `organization_personal_access_tokens: read` permission.
|
|
6145
|
+
*
|
|
6146
|
+
* **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.
|
|
6147
|
+
*/
|
|
6148
|
+
listPatGrants: {
|
|
6149
|
+
(params?: RestEndpointMethodTypes["orgs"]["listPatGrants"]["parameters"]): Promise<RestEndpointMethodTypes["orgs"]["listPatGrants"]["response"]>;
|
|
6150
|
+
defaults: RequestInterface["defaults"];
|
|
6151
|
+
endpoint: EndpointInterface<{
|
|
6152
|
+
url: string;
|
|
6153
|
+
}>;
|
|
6154
|
+
};
|
|
6155
|
+
/**
|
|
6156
|
+
* The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, or `hiring_manager`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`.
|
|
5777
6157
|
*/
|
|
5778
6158
|
listPendingInvitations: {
|
|
5779
6159
|
(params?: RestEndpointMethodTypes["orgs"]["listPendingInvitations"]["parameters"]): Promise<RestEndpointMethodTypes["orgs"]["listPendingInvitations"]["response"]>;
|
|
@@ -5896,6 +6276,32 @@ export declare type RestEndpointMethods = {
|
|
|
5896
6276
|
url: string;
|
|
5897
6277
|
}>;
|
|
5898
6278
|
};
|
|
6279
|
+
/**
|
|
6280
|
+
* Approves or denies a pending request to access organization resources via a fine-grained personal access token. Only GitHub Apps can call this API,
|
|
6281
|
+
* using the `organization_personal_access_token_requests: write` permission.
|
|
6282
|
+
*
|
|
6283
|
+
* **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.
|
|
6284
|
+
*/
|
|
6285
|
+
reviewPatGrantRequest: {
|
|
6286
|
+
(params?: RestEndpointMethodTypes["orgs"]["reviewPatGrantRequest"]["parameters"]): Promise<RestEndpointMethodTypes["orgs"]["reviewPatGrantRequest"]["response"]>;
|
|
6287
|
+
defaults: RequestInterface["defaults"];
|
|
6288
|
+
endpoint: EndpointInterface<{
|
|
6289
|
+
url: string;
|
|
6290
|
+
}>;
|
|
6291
|
+
};
|
|
6292
|
+
/**
|
|
6293
|
+
* Approves or denies multiple pending requests to access organization resources via a fine-grained personal access token. Only GitHub Apps can call this API,
|
|
6294
|
+
* using the `organization_personal_access_token_requests: write` permission.
|
|
6295
|
+
*
|
|
6296
|
+
* **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.
|
|
6297
|
+
*/
|
|
6298
|
+
reviewPatGrantRequestsInBulk: {
|
|
6299
|
+
(params?: RestEndpointMethodTypes["orgs"]["reviewPatGrantRequestsInBulk"]["parameters"]): Promise<RestEndpointMethodTypes["orgs"]["reviewPatGrantRequestsInBulk"]["response"]>;
|
|
6300
|
+
defaults: RequestInterface["defaults"];
|
|
6301
|
+
endpoint: EndpointInterface<{
|
|
6302
|
+
url: string;
|
|
6303
|
+
}>;
|
|
6304
|
+
};
|
|
5899
6305
|
/**
|
|
5900
6306
|
* Only authenticated organization owners can add a member to the organization or update the member's role.
|
|
5901
6307
|
*
|
|
@@ -5945,25 +6351,34 @@ export declare type RestEndpointMethods = {
|
|
|
5945
6351
|
url: string;
|
|
5946
6352
|
}>;
|
|
5947
6353
|
};
|
|
6354
|
+
updateMembershipForAuthenticatedUser: {
|
|
6355
|
+
(params?: RestEndpointMethodTypes["orgs"]["updateMembershipForAuthenticatedUser"]["parameters"]): Promise<RestEndpointMethodTypes["orgs"]["updateMembershipForAuthenticatedUser"]["response"]>;
|
|
6356
|
+
defaults: RequestInterface["defaults"];
|
|
6357
|
+
endpoint: EndpointInterface<{
|
|
6358
|
+
url: string;
|
|
6359
|
+
}>;
|
|
6360
|
+
};
|
|
5948
6361
|
/**
|
|
5949
|
-
*
|
|
5950
|
-
*
|
|
5951
|
-
* Updates a custom repository role that can be used by all repositories owned by the organization.
|
|
6362
|
+
* Updates the access an organization member has to organization resources via a fine-grained personal access token. Limited to revoking the token's existing access. Limited to revoking a token's existing access. Only GitHub Apps can call this API,
|
|
6363
|
+
* using the `organization_personal_access_tokens: write` permission.
|
|
5952
6364
|
*
|
|
5953
|
-
*
|
|
5954
|
-
* GitHub Apps must have the `organization_custom_roles:write` organization permission to use this endpoint.
|
|
5955
|
-
*
|
|
5956
|
-
* For more information about custom repository roles, see "[Managing custom repository roles for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)."
|
|
6365
|
+
* **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.
|
|
5957
6366
|
*/
|
|
5958
|
-
|
|
5959
|
-
(params?: RestEndpointMethodTypes["orgs"]["
|
|
6367
|
+
updatePatAccess: {
|
|
6368
|
+
(params?: RestEndpointMethodTypes["orgs"]["updatePatAccess"]["parameters"]): Promise<RestEndpointMethodTypes["orgs"]["updatePatAccess"]["response"]>;
|
|
5960
6369
|
defaults: RequestInterface["defaults"];
|
|
5961
6370
|
endpoint: EndpointInterface<{
|
|
5962
6371
|
url: string;
|
|
5963
6372
|
}>;
|
|
5964
6373
|
};
|
|
5965
|
-
|
|
5966
|
-
|
|
6374
|
+
/**
|
|
6375
|
+
* Updates the access organization members have to organization resources via fine-grained personal access tokens. Limited to revoking a token's existing access. Only GitHub Apps can call this API,
|
|
6376
|
+
* using the `organization_personal_access_tokens: write` permission.
|
|
6377
|
+
*
|
|
6378
|
+
* **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.
|
|
6379
|
+
*/
|
|
6380
|
+
updatePatAccesses: {
|
|
6381
|
+
(params?: RestEndpointMethodTypes["orgs"]["updatePatAccesses"]["parameters"]): Promise<RestEndpointMethodTypes["orgs"]["updatePatAccesses"]["response"]>;
|
|
5967
6382
|
defaults: RequestInterface["defaults"];
|
|
5968
6383
|
endpoint: EndpointInterface<{
|
|
5969
6384
|
url: string;
|
|
@@ -5996,8 +6411,8 @@ export declare type RestEndpointMethods = {
|
|
|
5996
6411
|
/**
|
|
5997
6412
|
* Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.
|
|
5998
6413
|
*
|
|
5999
|
-
* To use this endpoint, you must authenticate using an access token with the `packages
|
|
6000
|
-
* If `package_type`
|
|
6414
|
+
* To use this endpoint, you must authenticate using an access token with the `read:packages` and `delete:packages` scopes.
|
|
6415
|
+
* If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
|
|
6001
6416
|
*/
|
|
6002
6417
|
deletePackageForAuthenticatedUser: {
|
|
6003
6418
|
(params?: RestEndpointMethodTypes["packages"]["deletePackageForAuthenticatedUser"]["parameters"]): Promise<RestEndpointMethodTypes["packages"]["deletePackageForAuthenticatedUser"]["response"]>;
|
|
@@ -6009,9 +6424,9 @@ export declare type RestEndpointMethods = {
|
|
|
6009
6424
|
/**
|
|
6010
6425
|
* Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.
|
|
6011
6426
|
*
|
|
6012
|
-
* To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `packages
|
|
6013
|
-
* - If `package_type`
|
|
6014
|
-
* - If `package_type`
|
|
6427
|
+
* To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `delete:packages` scopes. In addition:
|
|
6428
|
+
* - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
|
|
6429
|
+
* - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package you want to delete. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."
|
|
6015
6430
|
*/
|
|
6016
6431
|
deletePackageForOrg: {
|
|
6017
6432
|
(params?: RestEndpointMethodTypes["packages"]["deletePackageForOrg"]["parameters"]): Promise<RestEndpointMethodTypes["packages"]["deletePackageForOrg"]["response"]>;
|
|
@@ -6023,9 +6438,9 @@ export declare type RestEndpointMethods = {
|
|
|
6023
6438
|
/**
|
|
6024
6439
|
* Deletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.
|
|
6025
6440
|
*
|
|
6026
|
-
* To use this endpoint, you must authenticate using an access token with the `packages
|
|
6027
|
-
* - If `package_type`
|
|
6028
|
-
* - If `package_type`
|
|
6441
|
+
* To use this endpoint, you must authenticate using an access token with the `read:packages` and `delete:packages` scopes. In addition:
|
|
6442
|
+
* - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
|
|
6443
|
+
* - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package you want to delete. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."
|
|
6029
6444
|
*/
|
|
6030
6445
|
deletePackageForUser: {
|
|
6031
6446
|
(params?: RestEndpointMethodTypes["packages"]["deletePackageForUser"]["parameters"]): Promise<RestEndpointMethodTypes["packages"]["deletePackageForUser"]["response"]>;
|
|
@@ -6037,8 +6452,8 @@ export declare type RestEndpointMethods = {
|
|
|
6037
6452
|
/**
|
|
6038
6453
|
* Deletes a specific package version for a package owned by the authenticated user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.
|
|
6039
6454
|
*
|
|
6040
|
-
* To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `packages
|
|
6041
|
-
* If `package_type`
|
|
6455
|
+
* To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `delete:packages` scopes.
|
|
6456
|
+
* If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
|
|
6042
6457
|
*/
|
|
6043
6458
|
deletePackageVersionForAuthenticatedUser: {
|
|
6044
6459
|
(params?: RestEndpointMethodTypes["packages"]["deletePackageVersionForAuthenticatedUser"]["parameters"]): Promise<RestEndpointMethodTypes["packages"]["deletePackageVersionForAuthenticatedUser"]["response"]>;
|
|
@@ -6050,9 +6465,9 @@ export declare type RestEndpointMethods = {
|
|
|
6050
6465
|
/**
|
|
6051
6466
|
* Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.
|
|
6052
6467
|
*
|
|
6053
|
-
* To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `packages
|
|
6054
|
-
* - If `package_type`
|
|
6055
|
-
* - If `package_type`
|
|
6468
|
+
* To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `delete:packages` scopes. In addition:
|
|
6469
|
+
* - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
|
|
6470
|
+
* - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package whose version you want to delete. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."
|
|
6056
6471
|
*/
|
|
6057
6472
|
deletePackageVersionForOrg: {
|
|
6058
6473
|
(params?: RestEndpointMethodTypes["packages"]["deletePackageVersionForOrg"]["parameters"]): Promise<RestEndpointMethodTypes["packages"]["deletePackageVersionForOrg"]["response"]>;
|
|
@@ -6064,9 +6479,9 @@ export declare type RestEndpointMethods = {
|
|
|
6064
6479
|
/**
|
|
6065
6480
|
* Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.
|
|
6066
6481
|
*
|
|
6067
|
-
* To use this endpoint, you must authenticate using an access token with the `packages
|
|
6068
|
-
* - If `package_type`
|
|
6069
|
-
* - If `package_type`
|
|
6482
|
+
* To use this endpoint, you must authenticate using an access token with the `read:packages` and `delete:packages` scopes. In addition:
|
|
6483
|
+
* - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
|
|
6484
|
+
* - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package whose version you want to delete. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."
|
|
6070
6485
|
*/
|
|
6071
6486
|
deletePackageVersionForUser: {
|
|
6072
6487
|
(params?: RestEndpointMethodTypes["packages"]["deletePackageVersionForUser"]["parameters"]): Promise<RestEndpointMethodTypes["packages"]["deletePackageVersionForUser"]["response"]>;
|
|
@@ -6078,8 +6493,7 @@ export declare type RestEndpointMethods = {
|
|
|
6078
6493
|
/**
|
|
6079
6494
|
* Lists package versions for a package owned by an organization.
|
|
6080
6495
|
*
|
|
6081
|
-
*
|
|
6082
|
-
* If `package_type` is not `container`, your token must also include the `repo` scope.
|
|
6496
|
+
* If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
|
|
6083
6497
|
* @deprecated octokit.rest.packages.getAllPackageVersionsForAPackageOwnedByAnOrg() has been renamed to octokit.rest.packages.getAllPackageVersionsForPackageOwnedByOrg() (2021-03-24)
|
|
6084
6498
|
*/
|
|
6085
6499
|
getAllPackageVersionsForAPackageOwnedByAnOrg: {
|
|
@@ -6092,8 +6506,7 @@ export declare type RestEndpointMethods = {
|
|
|
6092
6506
|
/**
|
|
6093
6507
|
* Lists package versions for a package owned by the authenticated user.
|
|
6094
6508
|
*
|
|
6095
|
-
* To use this endpoint, you must authenticate using an access token with the `packages
|
|
6096
|
-
* If `package_type` is not `container`, your token must also include the `repo` scope.
|
|
6509
|
+
* To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
|
|
6097
6510
|
* @deprecated octokit.rest.packages.getAllPackageVersionsForAPackageOwnedByTheAuthenticatedUser() has been renamed to octokit.rest.packages.getAllPackageVersionsForPackageOwnedByAuthenticatedUser() (2021-03-24)
|
|
6098
6511
|
*/
|
|
6099
6512
|
getAllPackageVersionsForAPackageOwnedByTheAuthenticatedUser: {
|
|
@@ -6106,8 +6519,7 @@ export declare type RestEndpointMethods = {
|
|
|
6106
6519
|
/**
|
|
6107
6520
|
* Lists package versions for a package owned by the authenticated user.
|
|
6108
6521
|
*
|
|
6109
|
-
* To use this endpoint, you must authenticate using an access token with the `packages
|
|
6110
|
-
* If `package_type` is not `container`, your token must also include the `repo` scope.
|
|
6522
|
+
* To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
|
|
6111
6523
|
*/
|
|
6112
6524
|
getAllPackageVersionsForPackageOwnedByAuthenticatedUser: {
|
|
6113
6525
|
(params?: RestEndpointMethodTypes["packages"]["getAllPackageVersionsForPackageOwnedByAuthenticatedUser"]["parameters"]): Promise<RestEndpointMethodTypes["packages"]["getAllPackageVersionsForPackageOwnedByAuthenticatedUser"]["response"]>;
|
|
@@ -6119,8 +6531,7 @@ export declare type RestEndpointMethods = {
|
|
|
6119
6531
|
/**
|
|
6120
6532
|
* Lists package versions for a package owned by an organization.
|
|
6121
6533
|
*
|
|
6122
|
-
*
|
|
6123
|
-
* If `package_type` is not `container`, your token must also include the `repo` scope.
|
|
6534
|
+
* If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
|
|
6124
6535
|
*/
|
|
6125
6536
|
getAllPackageVersionsForPackageOwnedByOrg: {
|
|
6126
6537
|
(params?: RestEndpointMethodTypes["packages"]["getAllPackageVersionsForPackageOwnedByOrg"]["parameters"]): Promise<RestEndpointMethodTypes["packages"]["getAllPackageVersionsForPackageOwnedByOrg"]["response"]>;
|
|
@@ -6132,8 +6543,7 @@ export declare type RestEndpointMethods = {
|
|
|
6132
6543
|
/**
|
|
6133
6544
|
* Lists package versions for a public package owned by a specified user.
|
|
6134
6545
|
*
|
|
6135
|
-
* To use this endpoint, you must authenticate using an access token with the `packages
|
|
6136
|
-
* If `package_type` is not `container`, your token must also include the `repo` scope.
|
|
6546
|
+
* To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
|
|
6137
6547
|
*/
|
|
6138
6548
|
getAllPackageVersionsForPackageOwnedByUser: {
|
|
6139
6549
|
(params?: RestEndpointMethodTypes["packages"]["getAllPackageVersionsForPackageOwnedByUser"]["parameters"]): Promise<RestEndpointMethodTypes["packages"]["getAllPackageVersionsForPackageOwnedByUser"]["response"]>;
|
|
@@ -6145,8 +6555,7 @@ export declare type RestEndpointMethods = {
|
|
|
6145
6555
|
/**
|
|
6146
6556
|
* Gets a specific package for a package owned by the authenticated user.
|
|
6147
6557
|
*
|
|
6148
|
-
* To use this endpoint, you must authenticate using an access token with the `packages
|
|
6149
|
-
* If `package_type` is not `container`, your token must also include the `repo` scope.
|
|
6558
|
+
* To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
|
|
6150
6559
|
*/
|
|
6151
6560
|
getPackageForAuthenticatedUser: {
|
|
6152
6561
|
(params?: RestEndpointMethodTypes["packages"]["getPackageForAuthenticatedUser"]["parameters"]): Promise<RestEndpointMethodTypes["packages"]["getPackageForAuthenticatedUser"]["response"]>;
|
|
@@ -6158,8 +6567,7 @@ export declare type RestEndpointMethods = {
|
|
|
6158
6567
|
/**
|
|
6159
6568
|
* Gets a specific package in an organization.
|
|
6160
6569
|
*
|
|
6161
|
-
* To use this endpoint, you must authenticate using an access token with the `packages
|
|
6162
|
-
* If `package_type` is not `container`, your token must also include the `repo` scope.
|
|
6570
|
+
* To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
|
|
6163
6571
|
*/
|
|
6164
6572
|
getPackageForOrganization: {
|
|
6165
6573
|
(params?: RestEndpointMethodTypes["packages"]["getPackageForOrganization"]["parameters"]): Promise<RestEndpointMethodTypes["packages"]["getPackageForOrganization"]["response"]>;
|
|
@@ -6171,8 +6579,7 @@ export declare type RestEndpointMethods = {
|
|
|
6171
6579
|
/**
|
|
6172
6580
|
* Gets a specific package metadata for a public package owned by a user.
|
|
6173
6581
|
*
|
|
6174
|
-
* To use this endpoint, you must authenticate using an access token with the `packages
|
|
6175
|
-
* If `package_type` is not `container`, your token must also include the `repo` scope.
|
|
6582
|
+
* To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
|
|
6176
6583
|
*/
|
|
6177
6584
|
getPackageForUser: {
|
|
6178
6585
|
(params?: RestEndpointMethodTypes["packages"]["getPackageForUser"]["parameters"]): Promise<RestEndpointMethodTypes["packages"]["getPackageForUser"]["response"]>;
|
|
@@ -6184,8 +6591,7 @@ export declare type RestEndpointMethods = {
|
|
|
6184
6591
|
/**
|
|
6185
6592
|
* Gets a specific package version for a package owned by the authenticated user.
|
|
6186
6593
|
*
|
|
6187
|
-
* To use this endpoint, you must authenticate using an access token with the `packages
|
|
6188
|
-
* If `package_type` is not `container`, your token must also include the `repo` scope.
|
|
6594
|
+
* To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
|
|
6189
6595
|
*/
|
|
6190
6596
|
getPackageVersionForAuthenticatedUser: {
|
|
6191
6597
|
(params?: RestEndpointMethodTypes["packages"]["getPackageVersionForAuthenticatedUser"]["parameters"]): Promise<RestEndpointMethodTypes["packages"]["getPackageVersionForAuthenticatedUser"]["response"]>;
|
|
@@ -6197,8 +6603,7 @@ export declare type RestEndpointMethods = {
|
|
|
6197
6603
|
/**
|
|
6198
6604
|
* Gets a specific package version in an organization.
|
|
6199
6605
|
*
|
|
6200
|
-
* You must authenticate using an access token with the `packages
|
|
6201
|
-
* If `package_type` is not `container`, your token must also include the `repo` scope.
|
|
6606
|
+
* You must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
|
|
6202
6607
|
*/
|
|
6203
6608
|
getPackageVersionForOrganization: {
|
|
6204
6609
|
(params?: RestEndpointMethodTypes["packages"]["getPackageVersionForOrganization"]["parameters"]): Promise<RestEndpointMethodTypes["packages"]["getPackageVersionForOrganization"]["response"]>;
|
|
@@ -6208,13 +6613,45 @@ export declare type RestEndpointMethods = {
|
|
|
6208
6613
|
}>;
|
|
6209
6614
|
};
|
|
6210
6615
|
/**
|
|
6211
|
-
* Gets a specific package version for a public package owned by a specified user.
|
|
6212
|
-
*
|
|
6213
|
-
* At this time, to use this endpoint, you must authenticate using an access token with the `packages
|
|
6214
|
-
|
|
6616
|
+
* Gets a specific package version for a public package owned by a specified user.
|
|
6617
|
+
*
|
|
6618
|
+
* At this time, to use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
|
|
6619
|
+
*/
|
|
6620
|
+
getPackageVersionForUser: {
|
|
6621
|
+
(params?: RestEndpointMethodTypes["packages"]["getPackageVersionForUser"]["parameters"]): Promise<RestEndpointMethodTypes["packages"]["getPackageVersionForUser"]["response"]>;
|
|
6622
|
+
defaults: RequestInterface["defaults"];
|
|
6623
|
+
endpoint: EndpointInterface<{
|
|
6624
|
+
url: string;
|
|
6625
|
+
}>;
|
|
6626
|
+
};
|
|
6627
|
+
/**
|
|
6628
|
+
* Lists all packages that are owned by the authenticated user within the user's namespace, and that encountered a conflict during a Docker migration.
|
|
6629
|
+
* To use this endpoint, you must authenticate using an access token with the `read:packages` scope.
|
|
6630
|
+
*/
|
|
6631
|
+
listDockerMigrationConflictingPackagesForAuthenticatedUser: {
|
|
6632
|
+
(params?: RestEndpointMethodTypes["packages"]["listDockerMigrationConflictingPackagesForAuthenticatedUser"]["parameters"]): Promise<RestEndpointMethodTypes["packages"]["listDockerMigrationConflictingPackagesForAuthenticatedUser"]["response"]>;
|
|
6633
|
+
defaults: RequestInterface["defaults"];
|
|
6634
|
+
endpoint: EndpointInterface<{
|
|
6635
|
+
url: string;
|
|
6636
|
+
}>;
|
|
6637
|
+
};
|
|
6638
|
+
/**
|
|
6639
|
+
* Lists all packages that are in a specific organization, are readable by the requesting user, and that encountered a conflict during a Docker migration.
|
|
6640
|
+
* To use this endpoint, you must authenticate using an access token with the `read:packages` scope.
|
|
6641
|
+
*/
|
|
6642
|
+
listDockerMigrationConflictingPackagesForOrganization: {
|
|
6643
|
+
(params?: RestEndpointMethodTypes["packages"]["listDockerMigrationConflictingPackagesForOrganization"]["parameters"]): Promise<RestEndpointMethodTypes["packages"]["listDockerMigrationConflictingPackagesForOrganization"]["response"]>;
|
|
6644
|
+
defaults: RequestInterface["defaults"];
|
|
6645
|
+
endpoint: EndpointInterface<{
|
|
6646
|
+
url: string;
|
|
6647
|
+
}>;
|
|
6648
|
+
};
|
|
6649
|
+
/**
|
|
6650
|
+
* Lists all packages that are in a specific user's namespace, that the requesting user has access to, and that encountered a conflict during Docker migration.
|
|
6651
|
+
* To use this endpoint, you must authenticate using an access token with the `read:packages` scope.
|
|
6215
6652
|
*/
|
|
6216
|
-
|
|
6217
|
-
(params?: RestEndpointMethodTypes["packages"]["
|
|
6653
|
+
listDockerMigrationConflictingPackagesForUser: {
|
|
6654
|
+
(params?: RestEndpointMethodTypes["packages"]["listDockerMigrationConflictingPackagesForUser"]["parameters"]): Promise<RestEndpointMethodTypes["packages"]["listDockerMigrationConflictingPackagesForUser"]["response"]>;
|
|
6218
6655
|
defaults: RequestInterface["defaults"];
|
|
6219
6656
|
endpoint: EndpointInterface<{
|
|
6220
6657
|
url: string;
|
|
@@ -6223,8 +6660,7 @@ export declare type RestEndpointMethods = {
|
|
|
6223
6660
|
/**
|
|
6224
6661
|
* Lists packages owned by the authenticated user within the user's namespace.
|
|
6225
6662
|
*
|
|
6226
|
-
* To use this endpoint, you must authenticate using an access token with the `packages
|
|
6227
|
-
* If `package_type` is not `container`, your token must also include the `repo` scope.
|
|
6663
|
+
* To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
|
|
6228
6664
|
*/
|
|
6229
6665
|
listPackagesForAuthenticatedUser: {
|
|
6230
6666
|
(params?: RestEndpointMethodTypes["packages"]["listPackagesForAuthenticatedUser"]["parameters"]): Promise<RestEndpointMethodTypes["packages"]["listPackagesForAuthenticatedUser"]["response"]>;
|
|
@@ -6234,10 +6670,9 @@ export declare type RestEndpointMethods = {
|
|
|
6234
6670
|
}>;
|
|
6235
6671
|
};
|
|
6236
6672
|
/**
|
|
6237
|
-
* Lists
|
|
6673
|
+
* Lists packages in an organization readable by the user.
|
|
6238
6674
|
*
|
|
6239
|
-
* To use this endpoint, you must authenticate using an access token with the `packages
|
|
6240
|
-
* If `package_type` is not `container`, your token must also include the `repo` scope.
|
|
6675
|
+
* To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
|
|
6241
6676
|
*/
|
|
6242
6677
|
listPackagesForOrganization: {
|
|
6243
6678
|
(params?: RestEndpointMethodTypes["packages"]["listPackagesForOrganization"]["parameters"]): Promise<RestEndpointMethodTypes["packages"]["listPackagesForOrganization"]["response"]>;
|
|
@@ -6249,8 +6684,7 @@ export declare type RestEndpointMethods = {
|
|
|
6249
6684
|
/**
|
|
6250
6685
|
* Lists all packages in a user's namespace for which the requesting user has access.
|
|
6251
6686
|
*
|
|
6252
|
-
* To use this endpoint, you must authenticate using an access token with the `packages
|
|
6253
|
-
* If `package_type` is not `container`, your token must also include the `repo` scope.
|
|
6687
|
+
* To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
|
|
6254
6688
|
*/
|
|
6255
6689
|
listPackagesForUser: {
|
|
6256
6690
|
(params?: RestEndpointMethodTypes["packages"]["listPackagesForUser"]["parameters"]): Promise<RestEndpointMethodTypes["packages"]["listPackagesForUser"]["response"]>;
|
|
@@ -6266,7 +6700,7 @@ export declare type RestEndpointMethods = {
|
|
|
6266
6700
|
* - The package was deleted within the last 30 days.
|
|
6267
6701
|
* - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.
|
|
6268
6702
|
*
|
|
6269
|
-
* To use this endpoint, you must authenticate using an access token with the `packages
|
|
6703
|
+
* To use this endpoint, you must authenticate using an access token with the `read:packages` and `write:packages` scopes. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
|
|
6270
6704
|
*/
|
|
6271
6705
|
restorePackageForAuthenticatedUser: {
|
|
6272
6706
|
(params?: RestEndpointMethodTypes["packages"]["restorePackageForAuthenticatedUser"]["parameters"]): Promise<RestEndpointMethodTypes["packages"]["restorePackageForAuthenticatedUser"]["response"]>;
|
|
@@ -6282,9 +6716,9 @@ export declare type RestEndpointMethods = {
|
|
|
6282
6716
|
* - The package was deleted within the last 30 days.
|
|
6283
6717
|
* - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.
|
|
6284
6718
|
*
|
|
6285
|
-
* To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `packages
|
|
6286
|
-
* - If `package_type`
|
|
6287
|
-
* - If `package_type`
|
|
6719
|
+
* To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `write:packages` scopes. In addition:
|
|
6720
|
+
* - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
|
|
6721
|
+
* - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package you want to restore. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."
|
|
6288
6722
|
*/
|
|
6289
6723
|
restorePackageForOrg: {
|
|
6290
6724
|
(params?: RestEndpointMethodTypes["packages"]["restorePackageForOrg"]["parameters"]): Promise<RestEndpointMethodTypes["packages"]["restorePackageForOrg"]["response"]>;
|
|
@@ -6300,9 +6734,9 @@ export declare type RestEndpointMethods = {
|
|
|
6300
6734
|
* - The package was deleted within the last 30 days.
|
|
6301
6735
|
* - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.
|
|
6302
6736
|
*
|
|
6303
|
-
* To use this endpoint, you must authenticate using an access token with the `packages
|
|
6304
|
-
* - If `package_type`
|
|
6305
|
-
* - If `package_type`
|
|
6737
|
+
* To use this endpoint, you must authenticate using an access token with the `read:packages` and `write:packages` scopes. In addition:
|
|
6738
|
+
* - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
|
|
6739
|
+
* - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package you want to restore. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."
|
|
6306
6740
|
*/
|
|
6307
6741
|
restorePackageForUser: {
|
|
6308
6742
|
(params?: RestEndpointMethodTypes["packages"]["restorePackageForUser"]["parameters"]): Promise<RestEndpointMethodTypes["packages"]["restorePackageForUser"]["response"]>;
|
|
@@ -6318,7 +6752,7 @@ export declare type RestEndpointMethods = {
|
|
|
6318
6752
|
* - The package was deleted within the last 30 days.
|
|
6319
6753
|
* - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.
|
|
6320
6754
|
*
|
|
6321
|
-
* To use this endpoint, you must authenticate using an access token with the `packages
|
|
6755
|
+
* To use this endpoint, you must authenticate using an access token with the `read:packages` and `write:packages` scopes. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
|
|
6322
6756
|
*/
|
|
6323
6757
|
restorePackageVersionForAuthenticatedUser: {
|
|
6324
6758
|
(params?: RestEndpointMethodTypes["packages"]["restorePackageVersionForAuthenticatedUser"]["parameters"]): Promise<RestEndpointMethodTypes["packages"]["restorePackageVersionForAuthenticatedUser"]["response"]>;
|
|
@@ -6334,9 +6768,9 @@ export declare type RestEndpointMethods = {
|
|
|
6334
6768
|
* - The package was deleted within the last 30 days.
|
|
6335
6769
|
* - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.
|
|
6336
6770
|
*
|
|
6337
|
-
* To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `packages
|
|
6338
|
-
* - If `package_type`
|
|
6339
|
-
* - If `package_type`
|
|
6771
|
+
* To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `write:packages` scopes. In addition:
|
|
6772
|
+
* - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
|
|
6773
|
+
* - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package whose version you want to restore. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."
|
|
6340
6774
|
*/
|
|
6341
6775
|
restorePackageVersionForOrg: {
|
|
6342
6776
|
(params?: RestEndpointMethodTypes["packages"]["restorePackageVersionForOrg"]["parameters"]): Promise<RestEndpointMethodTypes["packages"]["restorePackageVersionForOrg"]["response"]>;
|
|
@@ -6352,9 +6786,9 @@ export declare type RestEndpointMethods = {
|
|
|
6352
6786
|
* - The package was deleted within the last 30 days.
|
|
6353
6787
|
* - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.
|
|
6354
6788
|
*
|
|
6355
|
-
* To use this endpoint, you must authenticate using an access token with the `packages
|
|
6356
|
-
* - If `package_type`
|
|
6357
|
-
* - If `package_type`
|
|
6789
|
+
* To use this endpoint, you must authenticate using an access token with the `read:packages` and `write:packages` scopes. In addition:
|
|
6790
|
+
* - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
|
|
6791
|
+
* - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package whose version you want to restore. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."
|
|
6358
6792
|
*/
|
|
6359
6793
|
restorePackageVersionForUser: {
|
|
6360
6794
|
(params?: RestEndpointMethodTypes["packages"]["restorePackageVersionForUser"]["parameters"]): Promise<RestEndpointMethodTypes["packages"]["restorePackageVersionForUser"]["response"]>;
|
|
@@ -6578,6 +7012,9 @@ export declare type RestEndpointMethods = {
|
|
|
6578
7012
|
};
|
|
6579
7013
|
};
|
|
6580
7014
|
pulls: {
|
|
7015
|
+
/**
|
|
7016
|
+
* 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.
|
|
7017
|
+
*/
|
|
6581
7018
|
checkIfMerged: {
|
|
6582
7019
|
(params?: RestEndpointMethodTypes["pulls"]["checkIfMerged"]["parameters"]): Promise<RestEndpointMethodTypes["pulls"]["checkIfMerged"]["response"]>;
|
|
6583
7020
|
defaults: RequestInterface["defaults"];
|
|
@@ -6590,7 +7027,7 @@ export declare type RestEndpointMethods = {
|
|
|
6590
7027
|
*
|
|
6591
7028
|
* To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.
|
|
6592
7029
|
*
|
|
6593
|
-
* This endpoint triggers [notifications](https://docs.github.com/
|
|
7030
|
+
* This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details.
|
|
6594
7031
|
*/
|
|
6595
7032
|
create: {
|
|
6596
7033
|
(params?: RestEndpointMethodTypes["pulls"]["create"]["parameters"]): Promise<RestEndpointMethodTypes["pulls"]["create"]["response"]>;
|
|
@@ -6602,7 +7039,7 @@ export declare type RestEndpointMethods = {
|
|
|
6602
7039
|
/**
|
|
6603
7040
|
* Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported.
|
|
6604
7041
|
*
|
|
6605
|
-
* This endpoint triggers [notifications](https://docs.github.com/
|
|
7042
|
+
* This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details.
|
|
6606
7043
|
*/
|
|
6607
7044
|
createReplyForReviewComment: {
|
|
6608
7045
|
(params?: RestEndpointMethodTypes["pulls"]["createReplyForReviewComment"]["parameters"]): Promise<RestEndpointMethodTypes["pulls"]["createReplyForReviewComment"]["response"]>;
|
|
@@ -6612,11 +7049,11 @@ export declare type RestEndpointMethods = {
|
|
|
6612
7049
|
}>;
|
|
6613
7050
|
};
|
|
6614
7051
|
/**
|
|
6615
|
-
* This endpoint triggers [notifications](https://docs.github.com/
|
|
7052
|
+
* This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details.
|
|
6616
7053
|
*
|
|
6617
7054
|
* Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/rest/pulls#submit-a-review-for-a-pull-request)."
|
|
6618
7055
|
*
|
|
6619
|
-
* **Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API
|
|
7056
|
+
* **Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/rest/reference/pulls#get-a-pull-request) endpoint.
|
|
6620
7057
|
*
|
|
6621
7058
|
* The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
|
|
6622
7059
|
*/
|
|
@@ -6634,7 +7071,7 @@ export declare type RestEndpointMethods = {
|
|
|
6634
7071
|
*
|
|
6635
7072
|
* **Note:** The position value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
|
|
6636
7073
|
*
|
|
6637
|
-
* This endpoint triggers [notifications](https://docs.github.com/
|
|
7074
|
+
* This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details.
|
|
6638
7075
|
*/
|
|
6639
7076
|
createReviewComment: {
|
|
6640
7077
|
(params?: RestEndpointMethodTypes["pulls"]["createReviewComment"]["parameters"]): Promise<RestEndpointMethodTypes["pulls"]["createReviewComment"]["response"]>;
|
|
@@ -6643,6 +7080,9 @@ export declare type RestEndpointMethods = {
|
|
|
6643
7080
|
url: string;
|
|
6644
7081
|
}>;
|
|
6645
7082
|
};
|
|
7083
|
+
/**
|
|
7084
|
+
* Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted.
|
|
7085
|
+
*/
|
|
6646
7086
|
deletePendingReview: {
|
|
6647
7087
|
(params?: RestEndpointMethodTypes["pulls"]["deletePendingReview"]["parameters"]): Promise<RestEndpointMethodTypes["pulls"]["deletePendingReview"]["response"]>;
|
|
6648
7088
|
defaults: RequestInterface["defaults"];
|
|
@@ -6694,6 +7134,9 @@ export declare type RestEndpointMethods = {
|
|
|
6694
7134
|
url: string;
|
|
6695
7135
|
}>;
|
|
6696
7136
|
};
|
|
7137
|
+
/**
|
|
7138
|
+
* Retrieves a pull request review by its ID.
|
|
7139
|
+
*/
|
|
6697
7140
|
getReview: {
|
|
6698
7141
|
(params?: RestEndpointMethodTypes["pulls"]["getReview"]["parameters"]): Promise<RestEndpointMethodTypes["pulls"]["getReview"]["response"]>;
|
|
6699
7142
|
defaults: RequestInterface["defaults"];
|
|
@@ -6792,6 +7235,7 @@ export declare type RestEndpointMethods = {
|
|
|
6792
7235
|
}>;
|
|
6793
7236
|
};
|
|
6794
7237
|
/**
|
|
7238
|
+
* Merges a pull request into the base branch.
|
|
6795
7239
|
* This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details.
|
|
6796
7240
|
*/
|
|
6797
7241
|
merge: {
|
|
@@ -6801,6 +7245,9 @@ export declare type RestEndpointMethods = {
|
|
|
6801
7245
|
url: string;
|
|
6802
7246
|
}>;
|
|
6803
7247
|
};
|
|
7248
|
+
/**
|
|
7249
|
+
* Removes review requests from a pull request for a given set of users and/or teams.
|
|
7250
|
+
*/
|
|
6804
7251
|
removeRequestedReviewers: {
|
|
6805
7252
|
(params?: RestEndpointMethodTypes["pulls"]["removeRequestedReviewers"]["parameters"]): Promise<RestEndpointMethodTypes["pulls"]["removeRequestedReviewers"]["response"]>;
|
|
6806
7253
|
defaults: RequestInterface["defaults"];
|
|
@@ -7141,10 +7588,6 @@ export declare type RestEndpointMethods = {
|
|
|
7141
7588
|
* Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
|
|
7142
7589
|
*
|
|
7143
7590
|
* Grants the specified apps push access for this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.
|
|
7144
|
-
*
|
|
7145
|
-
* | Type | Description |
|
|
7146
|
-
* | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
7147
|
-
* | `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |
|
|
7148
7591
|
*/
|
|
7149
7592
|
addAppAccessRestrictions: {
|
|
7150
7593
|
(params?: RestEndpointMethodTypes["repos"]["addAppAccessRestrictions"]["parameters"]): Promise<RestEndpointMethodTypes["repos"]["addAppAccessRestrictions"]["response"]>;
|
|
@@ -7156,7 +7599,7 @@ export declare type RestEndpointMethods = {
|
|
|
7156
7599
|
/**
|
|
7157
7600
|
* This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details.
|
|
7158
7601
|
*
|
|
7159
|
-
* Adding an outside collaborator may be restricted by enterprise administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/
|
|
7602
|
+
* Adding an outside collaborator may be restricted by enterprise administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)."
|
|
7160
7603
|
*
|
|
7161
7604
|
* For more information on permission levels, see "[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:
|
|
7162
7605
|
*
|
|
@@ -7197,10 +7640,6 @@ export declare type RestEndpointMethods = {
|
|
|
7197
7640
|
* Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
|
|
7198
7641
|
*
|
|
7199
7642
|
* Grants the specified teams push access for this branch. You can also give push access to child teams.
|
|
7200
|
-
*
|
|
7201
|
-
* | Type | Description |
|
|
7202
|
-
* | ------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
7203
|
-
* | `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |
|
|
7204
7643
|
*/
|
|
7205
7644
|
addTeamAccessRestrictions: {
|
|
7206
7645
|
(params?: RestEndpointMethodTypes["repos"]["addTeamAccessRestrictions"]["parameters"]): Promise<RestEndpointMethodTypes["repos"]["addTeamAccessRestrictions"]["response"]>;
|
|
@@ -7242,7 +7681,7 @@ export declare type RestEndpointMethods = {
|
|
|
7242
7681
|
}>;
|
|
7243
7682
|
};
|
|
7244
7683
|
/**
|
|
7245
|
-
* Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin read access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/
|
|
7684
|
+
* Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin read access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/articles/about-security-alerts-for-vulnerable-dependencies)".
|
|
7246
7685
|
*/
|
|
7247
7686
|
checkVulnerabilityAlerts: {
|
|
7248
7687
|
(params?: RestEndpointMethodTypes["repos"]["checkVulnerabilityAlerts"]["parameters"]): Promise<RestEndpointMethodTypes["repos"]["checkVulnerabilityAlerts"]["response"]>;
|
|
@@ -7315,21 +7754,26 @@ export declare type RestEndpointMethods = {
|
|
|
7315
7754
|
}>;
|
|
7316
7755
|
};
|
|
7317
7756
|
/**
|
|
7318
|
-
*
|
|
7757
|
+
* Compares two commits against one another. You can compare branches in the same repository, or you can compare branches that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see "[Understanding connections between repositories](https://docs.github.com/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories)."
|
|
7319
7758
|
*
|
|
7320
|
-
*
|
|
7759
|
+
* This endpoint is equivalent to running the `git log BASE..HEAD` command, but it returns commits in a different order. The `git log BASE..HEAD` command returns commits in reverse chronological order, whereas the API returns commits in chronological order. You can pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.
|
|
7321
7760
|
*
|
|
7322
|
-
* The response
|
|
7761
|
+
* The API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file.
|
|
7762
|
+
*
|
|
7763
|
+
* When calling this endpoint without any paging parameter (`per_page` or `page`), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison.
|
|
7323
7764
|
*
|
|
7324
7765
|
* **Working with large comparisons**
|
|
7325
7766
|
*
|
|
7326
|
-
* To process a response with a large number of commits,
|
|
7767
|
+
* To process a response with a large number of commits, use a query parameter (`per_page` or `page`) to paginate the results. When using pagination:
|
|
7327
7768
|
*
|
|
7328
|
-
*
|
|
7769
|
+
* - The list of changed files is only shown on the first page of results, but it includes all changed files for the entire comparison.
|
|
7770
|
+
* - The results are returned in chronological order, but the last commit in the returned list may not be the most recent one in the entire set if there are more pages of results.
|
|
7771
|
+
*
|
|
7772
|
+
* For more information on working with pagination, see "[Using pagination in the REST API](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api)."
|
|
7329
7773
|
*
|
|
7330
7774
|
* **Signature verification object**
|
|
7331
7775
|
*
|
|
7332
|
-
* The response will include a `verification` object that describes the result of verifying the commit's signature. The
|
|
7776
|
+
* The response will include a `verification` object that describes the result of verifying the commit's signature. The `verification` object includes the following fields:
|
|
7333
7777
|
*
|
|
7334
7778
|
* | Name | Type | Description |
|
|
7335
7779
|
* | ---- | ---- | ----------- |
|
|
@@ -7349,7 +7793,7 @@ export declare type RestEndpointMethods = {
|
|
|
7349
7793
|
* | `unsigned` | The object does not include a signature. |
|
|
7350
7794
|
* | `unknown_signature_type` | A non-PGP signature was found in the commit. |
|
|
7351
7795
|
* | `no_user` | No user was associated with the `committer` email address in the commit. |
|
|
7352
|
-
* | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on
|
|
7796
|
+
* | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |
|
|
7353
7797
|
* | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |
|
|
7354
7798
|
* | `unknown_key` | The key that made the signature has not been registered with any user's account. |
|
|
7355
7799
|
* | `malformed_signature` | There was an error parsing the signature. |
|
|
@@ -7376,7 +7820,7 @@ export declare type RestEndpointMethods = {
|
|
|
7376
7820
|
/**
|
|
7377
7821
|
* Create a comment for a commit using its `:commit_sha`.
|
|
7378
7822
|
*
|
|
7379
|
-
* This endpoint triggers [notifications](https://docs.github.com/
|
|
7823
|
+
* This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details.
|
|
7380
7824
|
*/
|
|
7381
7825
|
createCommitComment: {
|
|
7382
7826
|
(params?: RestEndpointMethodTypes["repos"]["createCommitComment"]["parameters"]): Promise<RestEndpointMethodTypes["repos"]["createCommitComment"]["response"]>;
|
|
@@ -7485,6 +7929,20 @@ export declare type RestEndpointMethods = {
|
|
|
7485
7929
|
url: string;
|
|
7486
7930
|
}>;
|
|
7487
7931
|
};
|
|
7932
|
+
/**
|
|
7933
|
+
* Enable a custom deployment protection rule for an environment.
|
|
7934
|
+
*
|
|
7935
|
+
* You must authenticate using an access token with the `repo` scope to use this endpoint. Enabling a custom protection rule requires admin or owner permissions to the repository. GitHub Apps must have the `actions:write` permission to use this endpoint.
|
|
7936
|
+
*
|
|
7937
|
+
* For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app).
|
|
7938
|
+
*/
|
|
7939
|
+
createDeploymentProtectionRule: {
|
|
7940
|
+
(params?: RestEndpointMethodTypes["repos"]["createDeploymentProtectionRule"]["parameters"]): Promise<RestEndpointMethodTypes["repos"]["createDeploymentProtectionRule"]["response"]>;
|
|
7941
|
+
defaults: RequestInterface["defaults"];
|
|
7942
|
+
endpoint: EndpointInterface<{
|
|
7943
|
+
url: string;
|
|
7944
|
+
}>;
|
|
7945
|
+
};
|
|
7488
7946
|
/**
|
|
7489
7947
|
* Users with `push` access can create deployment statuses for a given deployment.
|
|
7490
7948
|
*
|
|
@@ -7537,6 +7995,8 @@ export declare type RestEndpointMethods = {
|
|
|
7537
7995
|
* Create a fork for the authenticated user.
|
|
7538
7996
|
*
|
|
7539
7997
|
* **Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api).
|
|
7998
|
+
*
|
|
7999
|
+
* **Note**: Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository.
|
|
7540
8000
|
*/
|
|
7541
8001
|
createFork: {
|
|
7542
8002
|
(params?: RestEndpointMethodTypes["repos"]["createFork"]["parameters"]): Promise<RestEndpointMethodTypes["repos"]["createFork"]["response"]>;
|
|
@@ -7590,6 +8050,16 @@ export declare type RestEndpointMethods = {
|
|
|
7590
8050
|
url: string;
|
|
7591
8051
|
}>;
|
|
7592
8052
|
};
|
|
8053
|
+
/**
|
|
8054
|
+
* Create a repository ruleset for an organization.
|
|
8055
|
+
*/
|
|
8056
|
+
createOrgRuleset: {
|
|
8057
|
+
(params?: RestEndpointMethodTypes["repos"]["createOrgRuleset"]["parameters"]): Promise<RestEndpointMethodTypes["repos"]["createOrgRuleset"]["response"]>;
|
|
8058
|
+
defaults: RequestInterface["defaults"];
|
|
8059
|
+
endpoint: EndpointInterface<{
|
|
8060
|
+
url: string;
|
|
8061
|
+
}>;
|
|
8062
|
+
};
|
|
7593
8063
|
/**
|
|
7594
8064
|
* Create a GitHub Pages deployment for a repository.
|
|
7595
8065
|
*
|
|
@@ -7604,6 +8074,8 @@ export declare type RestEndpointMethods = {
|
|
|
7604
8074
|
};
|
|
7605
8075
|
/**
|
|
7606
8076
|
* Configures a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages)."
|
|
8077
|
+
*
|
|
8078
|
+
* To use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the `repo` scope or Pages write permission is required. GitHub Apps must have the `administration:write` and `pages:write` permissions.
|
|
7607
8079
|
*/
|
|
7608
8080
|
createPagesSite: {
|
|
7609
8081
|
(params?: RestEndpointMethodTypes["repos"]["createPagesSite"]["parameters"]): Promise<RestEndpointMethodTypes["repos"]["createPagesSite"]["response"]>;
|
|
@@ -7615,7 +8087,7 @@ export declare type RestEndpointMethods = {
|
|
|
7615
8087
|
/**
|
|
7616
8088
|
* Users with push access to the repository can create a release.
|
|
7617
8089
|
*
|
|
7618
|
-
* This endpoint triggers [notifications](https://docs.github.com/
|
|
8090
|
+
* This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details.
|
|
7619
8091
|
*/
|
|
7620
8092
|
createRelease: {
|
|
7621
8093
|
(params?: RestEndpointMethodTypes["repos"]["createRelease"]["parameters"]): Promise<RestEndpointMethodTypes["repos"]["createRelease"]["response"]>;
|
|
@@ -7624,6 +8096,16 @@ export declare type RestEndpointMethods = {
|
|
|
7624
8096
|
url: string;
|
|
7625
8097
|
}>;
|
|
7626
8098
|
};
|
|
8099
|
+
/**
|
|
8100
|
+
* Create a ruleset for a repository.
|
|
8101
|
+
*/
|
|
8102
|
+
createRepoRuleset: {
|
|
8103
|
+
(params?: RestEndpointMethodTypes["repos"]["createRepoRuleset"]["parameters"]): Promise<RestEndpointMethodTypes["repos"]["createRepoRuleset"]["response"]>;
|
|
8104
|
+
defaults: RequestInterface["defaults"];
|
|
8105
|
+
endpoint: EndpointInterface<{
|
|
8106
|
+
url: string;
|
|
8107
|
+
}>;
|
|
8108
|
+
};
|
|
7627
8109
|
/**
|
|
7628
8110
|
* This creates a tag protection state for a repository.
|
|
7629
8111
|
* This endpoint is only available to repository administrators.
|
|
@@ -7786,7 +8268,7 @@ export declare type RestEndpointMethods = {
|
|
|
7786
8268
|
* * Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment.
|
|
7787
8269
|
* * Mark the active deployment as inactive by adding any non-successful deployment status.
|
|
7788
8270
|
*
|
|
7789
|
-
* For more information, see "[Create a deployment](https://docs.github.com/rest/
|
|
8271
|
+
* For more information, see "[Create a deployment](https://docs.github.com/rest/deployments/deployments/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/rest/deployments/deployment-statuses#create-a-deployment-status)."
|
|
7790
8272
|
*/
|
|
7791
8273
|
deleteDeployment: {
|
|
7792
8274
|
(params?: RestEndpointMethodTypes["repos"]["deleteDeployment"]["parameters"]): Promise<RestEndpointMethodTypes["repos"]["deleteDeployment"]["response"]>;
|
|
@@ -7832,6 +8314,21 @@ export declare type RestEndpointMethods = {
|
|
|
7832
8314
|
url: string;
|
|
7833
8315
|
}>;
|
|
7834
8316
|
};
|
|
8317
|
+
/**
|
|
8318
|
+
* Delete a ruleset for an organization.
|
|
8319
|
+
*/
|
|
8320
|
+
deleteOrgRuleset: {
|
|
8321
|
+
(params?: RestEndpointMethodTypes["repos"]["deleteOrgRuleset"]["parameters"]): Promise<RestEndpointMethodTypes["repos"]["deleteOrgRuleset"]["response"]>;
|
|
8322
|
+
defaults: RequestInterface["defaults"];
|
|
8323
|
+
endpoint: EndpointInterface<{
|
|
8324
|
+
url: string;
|
|
8325
|
+
}>;
|
|
8326
|
+
};
|
|
8327
|
+
/**
|
|
8328
|
+
* Deletes a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages).
|
|
8329
|
+
*
|
|
8330
|
+
* To use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the `repo` scope or Pages write permission is required. GitHub Apps must have the `administration:write` and `pages:write` permissions.
|
|
8331
|
+
*/
|
|
7835
8332
|
deletePagesSite: {
|
|
7836
8333
|
(params?: RestEndpointMethodTypes["repos"]["deletePagesSite"]["parameters"]): Promise<RestEndpointMethodTypes["repos"]["deletePagesSite"]["response"]>;
|
|
7837
8334
|
defaults: RequestInterface["defaults"];
|
|
@@ -7866,6 +8363,16 @@ export declare type RestEndpointMethods = {
|
|
|
7866
8363
|
url: string;
|
|
7867
8364
|
}>;
|
|
7868
8365
|
};
|
|
8366
|
+
/**
|
|
8367
|
+
* Delete a ruleset for a repository.
|
|
8368
|
+
*/
|
|
8369
|
+
deleteRepoRuleset: {
|
|
8370
|
+
(params?: RestEndpointMethodTypes["repos"]["deleteRepoRuleset"]["parameters"]): Promise<RestEndpointMethodTypes["repos"]["deleteRepoRuleset"]["response"]>;
|
|
8371
|
+
defaults: RequestInterface["defaults"];
|
|
8372
|
+
endpoint: EndpointInterface<{
|
|
8373
|
+
url: string;
|
|
8374
|
+
}>;
|
|
8375
|
+
};
|
|
7869
8376
|
/**
|
|
7870
8377
|
* This deletes a tag protection state for a repository.
|
|
7871
8378
|
* This endpoint is only available to repository administrators.
|
|
@@ -7885,7 +8392,7 @@ export declare type RestEndpointMethods = {
|
|
|
7885
8392
|
}>;
|
|
7886
8393
|
};
|
|
7887
8394
|
/**
|
|
7888
|
-
* Disables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/
|
|
8395
|
+
* Disables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/articles/configuring-automated-security-fixes)".
|
|
7889
8396
|
*/
|
|
7890
8397
|
disableAutomatedSecurityFixes: {
|
|
7891
8398
|
(params?: RestEndpointMethodTypes["repos"]["disableAutomatedSecurityFixes"]["parameters"]): Promise<RestEndpointMethodTypes["repos"]["disableAutomatedSecurityFixes"]["response"]>;
|
|
@@ -7894,6 +8401,21 @@ export declare type RestEndpointMethods = {
|
|
|
7894
8401
|
url: string;
|
|
7895
8402
|
}>;
|
|
7896
8403
|
};
|
|
8404
|
+
/**
|
|
8405
|
+
* Disables a custom deployment protection rule for an environment.
|
|
8406
|
+
*
|
|
8407
|
+
* You must authenticate using an access token with the `repo` scope to use this endpoint. Removing a custom protection rule requires admin or owner permissions to the repository. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see "[Get an app](https://docs.github.com/rest/apps/apps#get-an-app)".
|
|
8408
|
+
*/
|
|
8409
|
+
disableDeploymentProtectionRule: {
|
|
8410
|
+
(params?: RestEndpointMethodTypes["repos"]["disableDeploymentProtectionRule"]["parameters"]): Promise<RestEndpointMethodTypes["repos"]["disableDeploymentProtectionRule"]["response"]>;
|
|
8411
|
+
defaults: RequestInterface["defaults"];
|
|
8412
|
+
endpoint: EndpointInterface<{
|
|
8413
|
+
url: string;
|
|
8414
|
+
}>;
|
|
8415
|
+
};
|
|
8416
|
+
/**
|
|
8417
|
+
* Disables Git LFS for a repository. Access tokens must have the `admin:enterprise` scope.
|
|
8418
|
+
*/
|
|
7897
8419
|
disableLfsForRepo: {
|
|
7898
8420
|
(params?: RestEndpointMethodTypes["repos"]["disableLfsForRepo"]["parameters"]): Promise<RestEndpointMethodTypes["repos"]["disableLfsForRepo"]["response"]>;
|
|
7899
8421
|
defaults: RequestInterface["defaults"];
|
|
@@ -7902,7 +8424,9 @@ export declare type RestEndpointMethods = {
|
|
|
7902
8424
|
}>;
|
|
7903
8425
|
};
|
|
7904
8426
|
/**
|
|
7905
|
-
* Disables dependency alerts and the dependency graph for a repository.
|
|
8427
|
+
* Disables dependency alerts and the dependency graph for a repository.
|
|
8428
|
+
* The authenticated user must have admin access to the repository. For more information,
|
|
8429
|
+
* see "[About security alerts for vulnerable dependencies](https://docs.github.com/articles/about-security-alerts-for-vulnerable-dependencies)".
|
|
7906
8430
|
*/
|
|
7907
8431
|
disableVulnerabilityAlerts: {
|
|
7908
8432
|
(params?: RestEndpointMethodTypes["repos"]["disableVulnerabilityAlerts"]["parameters"]): Promise<RestEndpointMethodTypes["repos"]["disableVulnerabilityAlerts"]["response"]>;
|
|
@@ -7913,7 +8437,7 @@ export declare type RestEndpointMethods = {
|
|
|
7913
8437
|
};
|
|
7914
8438
|
/**
|
|
7915
8439
|
* Gets a redirect URL to download a zip archive for a repository. If you omit `:ref`, the repository’s default branch (usually
|
|
7916
|
-
* `
|
|
8440
|
+
* `main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use
|
|
7917
8441
|
* the `Location` header to make a second `GET` request.
|
|
7918
8442
|
*
|
|
7919
8443
|
* **Note**: For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect.
|
|
@@ -7928,7 +8452,7 @@ export declare type RestEndpointMethods = {
|
|
|
7928
8452
|
};
|
|
7929
8453
|
/**
|
|
7930
8454
|
* Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually
|
|
7931
|
-
* `
|
|
8455
|
+
* `main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use
|
|
7932
8456
|
* the `Location` header to make a second `GET` request.
|
|
7933
8457
|
* **Note**: For private repositories, these links are temporary and expire after five minutes.
|
|
7934
8458
|
*/
|
|
@@ -7941,7 +8465,7 @@ export declare type RestEndpointMethods = {
|
|
|
7941
8465
|
};
|
|
7942
8466
|
/**
|
|
7943
8467
|
* Gets a redirect URL to download a zip archive for a repository. If you omit `:ref`, the repository’s default branch (usually
|
|
7944
|
-
* `
|
|
8468
|
+
* `main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use
|
|
7945
8469
|
* the `Location` header to make a second `GET` request.
|
|
7946
8470
|
*
|
|
7947
8471
|
* **Note**: For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect.
|
|
@@ -7954,7 +8478,7 @@ export declare type RestEndpointMethods = {
|
|
|
7954
8478
|
}>;
|
|
7955
8479
|
};
|
|
7956
8480
|
/**
|
|
7957
|
-
* Enables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/
|
|
8481
|
+
* Enables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/articles/configuring-automated-security-fixes)".
|
|
7958
8482
|
*/
|
|
7959
8483
|
enableAutomatedSecurityFixes: {
|
|
7960
8484
|
(params?: RestEndpointMethodTypes["repos"]["enableAutomatedSecurityFixes"]["parameters"]): Promise<RestEndpointMethodTypes["repos"]["enableAutomatedSecurityFixes"]["response"]>;
|
|
@@ -7963,6 +8487,9 @@ export declare type RestEndpointMethods = {
|
|
|
7963
8487
|
url: string;
|
|
7964
8488
|
}>;
|
|
7965
8489
|
};
|
|
8490
|
+
/**
|
|
8491
|
+
* Enables Git LFS for a repository. Access tokens must have the `admin:enterprise` scope.
|
|
8492
|
+
*/
|
|
7966
8493
|
enableLfsForRepo: {
|
|
7967
8494
|
(params?: RestEndpointMethodTypes["repos"]["enableLfsForRepo"]["parameters"]): Promise<RestEndpointMethodTypes["repos"]["enableLfsForRepo"]["response"]>;
|
|
7968
8495
|
defaults: RequestInterface["defaults"];
|
|
@@ -7971,7 +8498,7 @@ export declare type RestEndpointMethods = {
|
|
|
7971
8498
|
}>;
|
|
7972
8499
|
};
|
|
7973
8500
|
/**
|
|
7974
|
-
* Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/
|
|
8501
|
+
* Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/articles/about-security-alerts-for-vulnerable-dependencies)".
|
|
7975
8502
|
*/
|
|
7976
8503
|
enableVulnerabilityAlerts: {
|
|
7977
8504
|
(params?: RestEndpointMethodTypes["repos"]["enableVulnerabilityAlerts"]["parameters"]): Promise<RestEndpointMethodTypes["repos"]["enableVulnerabilityAlerts"]["response"]>;
|
|
@@ -7992,6 +8519,8 @@ export declare type RestEndpointMethods = {
|
|
|
7992
8519
|
};
|
|
7993
8520
|
/**
|
|
7994
8521
|
* The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network.
|
|
8522
|
+
*
|
|
8523
|
+
* **Note:** In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)."
|
|
7995
8524
|
*/
|
|
7996
8525
|
get: {
|
|
7997
8526
|
(params?: RestEndpointMethodTypes["repos"]["get"]["parameters"]): Promise<RestEndpointMethodTypes["repos"]["get"]["response"]>;
|
|
@@ -8024,6 +8553,18 @@ export declare type RestEndpointMethods = {
|
|
|
8024
8553
|
url: string;
|
|
8025
8554
|
}>;
|
|
8026
8555
|
};
|
|
8556
|
+
/**
|
|
8557
|
+
* Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the `repo` scope. GitHub Apps and fine-grained personal access tokens must have the `actions:read` permission to use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment)."
|
|
8558
|
+
*
|
|
8559
|
+
* For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app).
|
|
8560
|
+
*/
|
|
8561
|
+
getAllDeploymentProtectionRules: {
|
|
8562
|
+
(params?: RestEndpointMethodTypes["repos"]["getAllDeploymentProtectionRules"]["parameters"]): Promise<RestEndpointMethodTypes["repos"]["getAllDeploymentProtectionRules"]["response"]>;
|
|
8563
|
+
defaults: RequestInterface["defaults"];
|
|
8564
|
+
endpoint: EndpointInterface<{
|
|
8565
|
+
url: string;
|
|
8566
|
+
}>;
|
|
8567
|
+
};
|
|
8027
8568
|
/**
|
|
8028
8569
|
* Lists the environments for a repository.
|
|
8029
8570
|
*
|
|
@@ -8094,6 +8635,16 @@ export declare type RestEndpointMethods = {
|
|
|
8094
8635
|
url: string;
|
|
8095
8636
|
}>;
|
|
8096
8637
|
};
|
|
8638
|
+
/**
|
|
8639
|
+
* Returns all rules that apply to the specified branch.
|
|
8640
|
+
*/
|
|
8641
|
+
getBranchRules: {
|
|
8642
|
+
(params?: RestEndpointMethodTypes["repos"]["getBranchRules"]["parameters"]): Promise<RestEndpointMethodTypes["repos"]["getBranchRules"]["response"]>;
|
|
8643
|
+
defaults: RequestInterface["defaults"];
|
|
8644
|
+
endpoint: EndpointInterface<{
|
|
8645
|
+
url: string;
|
|
8646
|
+
}>;
|
|
8647
|
+
};
|
|
8097
8648
|
/**
|
|
8098
8649
|
* Get the total number of clones and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday.
|
|
8099
8650
|
*/
|
|
@@ -8172,7 +8723,7 @@ export declare type RestEndpointMethods = {
|
|
|
8172
8723
|
* | `unsigned` | The object does not include a signature. |
|
|
8173
8724
|
* | `unknown_signature_type` | A non-PGP signature was found in the commit. |
|
|
8174
8725
|
* | `no_user` | No user was associated with the `committer` email address in the commit. |
|
|
8175
|
-
* | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on
|
|
8726
|
+
* | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |
|
|
8176
8727
|
* | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |
|
|
8177
8728
|
* | `unknown_key` | The key that made the signature has not been registered with any user's account. |
|
|
8178
8729
|
* | `malformed_signature` | There was an error parsing the signature. |
|
|
@@ -8218,7 +8769,7 @@ export declare type RestEndpointMethods = {
|
|
|
8218
8769
|
}>;
|
|
8219
8770
|
};
|
|
8220
8771
|
/**
|
|
8221
|
-
* Returns all community profile metrics for a repository. The repository
|
|
8772
|
+
* Returns all community profile metrics for a repository. The repository cannot be a fork.
|
|
8222
8773
|
*
|
|
8223
8774
|
* The returned metrics include an overall health score, the repository description, the presence of documentation, the
|
|
8224
8775
|
* detected code of conduct, the detected license, and the presence of ISSUE\_TEMPLATE, PULL\_REQUEST\_TEMPLATE,
|
|
@@ -8300,6 +8851,18 @@ export declare type RestEndpointMethods = {
|
|
|
8300
8851
|
url: string;
|
|
8301
8852
|
}>;
|
|
8302
8853
|
};
|
|
8854
|
+
/**
|
|
8855
|
+
* Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the `repo` scope. GitHub Apps and fine-grained personal access tokens must have the `actions:read` permission to use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment)."
|
|
8856
|
+
*
|
|
8857
|
+
* For more information about the app that is providing this custom deployment rule, see [`GET /apps/{app_slug}`](https://docs.github.com/rest/apps/apps#get-an-app).
|
|
8858
|
+
*/
|
|
8859
|
+
getCustomDeploymentProtectionRule: {
|
|
8860
|
+
(params?: RestEndpointMethodTypes["repos"]["getCustomDeploymentProtectionRule"]["parameters"]): Promise<RestEndpointMethodTypes["repos"]["getCustomDeploymentProtectionRule"]["response"]>;
|
|
8861
|
+
defaults: RequestInterface["defaults"];
|
|
8862
|
+
endpoint: EndpointInterface<{
|
|
8863
|
+
url: string;
|
|
8864
|
+
}>;
|
|
8865
|
+
};
|
|
8303
8866
|
getDeployKey: {
|
|
8304
8867
|
(params?: RestEndpointMethodTypes["repos"]["getDeployKey"]["parameters"]): Promise<RestEndpointMethodTypes["repos"]["getDeployKey"]["response"]>;
|
|
8305
8868
|
defaults: RequestInterface["defaults"];
|
|
@@ -8350,6 +8913,11 @@ export declare type RestEndpointMethods = {
|
|
|
8350
8913
|
url: string;
|
|
8351
8914
|
}>;
|
|
8352
8915
|
};
|
|
8916
|
+
/**
|
|
8917
|
+
* Gets information about the single most recent build of a GitHub Pages site.
|
|
8918
|
+
*
|
|
8919
|
+
* A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission.
|
|
8920
|
+
*/
|
|
8353
8921
|
getLatestPagesBuild: {
|
|
8354
8922
|
(params?: RestEndpointMethodTypes["repos"]["getLatestPagesBuild"]["parameters"]): Promise<RestEndpointMethodTypes["repos"]["getLatestPagesBuild"]["response"]>;
|
|
8355
8923
|
defaults: RequestInterface["defaults"];
|
|
@@ -8369,6 +8937,31 @@ export declare type RestEndpointMethods = {
|
|
|
8369
8937
|
url: string;
|
|
8370
8938
|
}>;
|
|
8371
8939
|
};
|
|
8940
|
+
/**
|
|
8941
|
+
* Get a repository ruleset for an organization.
|
|
8942
|
+
*/
|
|
8943
|
+
getOrgRuleset: {
|
|
8944
|
+
(params?: RestEndpointMethodTypes["repos"]["getOrgRuleset"]["parameters"]): Promise<RestEndpointMethodTypes["repos"]["getOrgRuleset"]["response"]>;
|
|
8945
|
+
defaults: RequestInterface["defaults"];
|
|
8946
|
+
endpoint: EndpointInterface<{
|
|
8947
|
+
url: string;
|
|
8948
|
+
}>;
|
|
8949
|
+
};
|
|
8950
|
+
/**
|
|
8951
|
+
* Get all the repository rulesets for an organization.
|
|
8952
|
+
*/
|
|
8953
|
+
getOrgRulesets: {
|
|
8954
|
+
(params?: RestEndpointMethodTypes["repos"]["getOrgRulesets"]["parameters"]): Promise<RestEndpointMethodTypes["repos"]["getOrgRulesets"]["response"]>;
|
|
8955
|
+
defaults: RequestInterface["defaults"];
|
|
8956
|
+
endpoint: EndpointInterface<{
|
|
8957
|
+
url: string;
|
|
8958
|
+
}>;
|
|
8959
|
+
};
|
|
8960
|
+
/**
|
|
8961
|
+
* Gets information about a GitHub Pages site.
|
|
8962
|
+
*
|
|
8963
|
+
* A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission.
|
|
8964
|
+
*/
|
|
8372
8965
|
getPages: {
|
|
8373
8966
|
(params?: RestEndpointMethodTypes["repos"]["getPages"]["parameters"]): Promise<RestEndpointMethodTypes["repos"]["getPages"]["response"]>;
|
|
8374
8967
|
defaults: RequestInterface["defaults"];
|
|
@@ -8376,6 +8969,11 @@ export declare type RestEndpointMethods = {
|
|
|
8376
8969
|
url: string;
|
|
8377
8970
|
}>;
|
|
8378
8971
|
};
|
|
8972
|
+
/**
|
|
8973
|
+
* Gets information about a GitHub Pages build.
|
|
8974
|
+
*
|
|
8975
|
+
* A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission.
|
|
8976
|
+
*/
|
|
8379
8977
|
getPagesBuild: {
|
|
8380
8978
|
(params?: RestEndpointMethodTypes["repos"]["getPagesBuild"]["parameters"]): Promise<RestEndpointMethodTypes["repos"]["getPagesBuild"]["response"]>;
|
|
8381
8979
|
defaults: RequestInterface["defaults"];
|
|
@@ -8388,7 +8986,7 @@ export declare type RestEndpointMethods = {
|
|
|
8388
8986
|
*
|
|
8389
8987
|
* The first request to this endpoint returns a `202 Accepted` status and starts an asynchronous background task to get the results for the domain. After the background task completes, subsequent requests to this endpoint return a `200 OK` status with the health check results in the response.
|
|
8390
8988
|
*
|
|
8391
|
-
*
|
|
8989
|
+
* To use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the `repo` scope or Pages write permission is required. GitHub Apps must have the `administrative:write` and `pages:write` permissions.
|
|
8392
8990
|
*/
|
|
8393
8991
|
getPagesHealthCheck: {
|
|
8394
8992
|
(params?: RestEndpointMethodTypes["repos"]["getPagesHealthCheck"]["parameters"]): Promise<RestEndpointMethodTypes["repos"]["getPagesHealthCheck"]["response"]>;
|
|
@@ -8489,6 +9087,26 @@ export declare type RestEndpointMethods = {
|
|
|
8489
9087
|
url: string;
|
|
8490
9088
|
}>;
|
|
8491
9089
|
};
|
|
9090
|
+
/**
|
|
9091
|
+
* Get a ruleset for a repository.
|
|
9092
|
+
*/
|
|
9093
|
+
getRepoRuleset: {
|
|
9094
|
+
(params?: RestEndpointMethodTypes["repos"]["getRepoRuleset"]["parameters"]): Promise<RestEndpointMethodTypes["repos"]["getRepoRuleset"]["response"]>;
|
|
9095
|
+
defaults: RequestInterface["defaults"];
|
|
9096
|
+
endpoint: EndpointInterface<{
|
|
9097
|
+
url: string;
|
|
9098
|
+
}>;
|
|
9099
|
+
};
|
|
9100
|
+
/**
|
|
9101
|
+
* Get all the rulesets for a repository.
|
|
9102
|
+
*/
|
|
9103
|
+
getRepoRulesets: {
|
|
9104
|
+
(params?: RestEndpointMethodTypes["repos"]["getRepoRulesets"]["parameters"]): Promise<RestEndpointMethodTypes["repos"]["getRepoRulesets"]["response"]>;
|
|
9105
|
+
defaults: RequestInterface["defaults"];
|
|
9106
|
+
endpoint: EndpointInterface<{
|
|
9107
|
+
url: string;
|
|
9108
|
+
}>;
|
|
9109
|
+
};
|
|
8492
9110
|
/**
|
|
8493
9111
|
* Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
|
|
8494
9112
|
*/
|
|
@@ -8690,7 +9308,7 @@ export declare type RestEndpointMethods = {
|
|
|
8690
9308
|
* | `unsigned` | The object does not include a signature. |
|
|
8691
9309
|
* | `unknown_signature_type` | A non-PGP signature was found in the commit. |
|
|
8692
9310
|
* | `no_user` | No user was associated with the `committer` email address in the commit. |
|
|
8693
|
-
* | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on
|
|
9311
|
+
* | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |
|
|
8694
9312
|
* | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |
|
|
8695
9313
|
* | `unknown_key` | The key that made the signature has not been registered with any user's account. |
|
|
8696
9314
|
* | `malformed_signature` | There was an error parsing the signature. |
|
|
@@ -8705,7 +9323,7 @@ export declare type RestEndpointMethods = {
|
|
|
8705
9323
|
}>;
|
|
8706
9324
|
};
|
|
8707
9325
|
/**
|
|
8708
|
-
* Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API
|
|
9326
|
+
* Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API caches contributor data to improve performance.
|
|
8709
9327
|
*
|
|
8710
9328
|
* GitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information.
|
|
8711
9329
|
*/
|
|
@@ -8716,6 +9334,20 @@ export declare type RestEndpointMethods = {
|
|
|
8716
9334
|
url: string;
|
|
8717
9335
|
}>;
|
|
8718
9336
|
};
|
|
9337
|
+
/**
|
|
9338
|
+
* Gets all custom deployment protection rule integrations that are available for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the `repo` scope. GitHub Apps and fine-grained personal access tokens must have the `actions:read` permission to use this endpoint.
|
|
9339
|
+
*
|
|
9340
|
+
* For more information about environments, see "[Using environments for deployment](https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment)."
|
|
9341
|
+
*
|
|
9342
|
+
* For more information about the app that is providing this custom deployment rule, see "[GET an app](https://docs.github.com/rest/apps/apps#get-an-app)".
|
|
9343
|
+
*/
|
|
9344
|
+
listCustomDeploymentRuleIntegrations: {
|
|
9345
|
+
(params?: RestEndpointMethodTypes["repos"]["listCustomDeploymentRuleIntegrations"]["parameters"]): Promise<RestEndpointMethodTypes["repos"]["listCustomDeploymentRuleIntegrations"]["response"]>;
|
|
9346
|
+
defaults: RequestInterface["defaults"];
|
|
9347
|
+
endpoint: EndpointInterface<{
|
|
9348
|
+
url: string;
|
|
9349
|
+
}>;
|
|
9350
|
+
};
|
|
8719
9351
|
listDeployKeys: {
|
|
8720
9352
|
(params?: RestEndpointMethodTypes["repos"]["listDeployKeys"]["parameters"]): Promise<RestEndpointMethodTypes["repos"]["listDeployKeys"]["response"]>;
|
|
8721
9353
|
defaults: RequestInterface["defaults"];
|
|
@@ -8769,6 +9401,8 @@ export declare type RestEndpointMethods = {
|
|
|
8769
9401
|
};
|
|
8770
9402
|
/**
|
|
8771
9403
|
* Lists repositories for the specified organization.
|
|
9404
|
+
*
|
|
9405
|
+
* **Note:** In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)."
|
|
8772
9406
|
*/
|
|
8773
9407
|
listForOrg: {
|
|
8774
9408
|
(params?: RestEndpointMethodTypes["repos"]["listForOrg"]["parameters"]): Promise<RestEndpointMethodTypes["repos"]["listForOrg"]["response"]>;
|
|
@@ -8824,6 +9458,11 @@ export declare type RestEndpointMethods = {
|
|
|
8824
9458
|
url: string;
|
|
8825
9459
|
}>;
|
|
8826
9460
|
};
|
|
9461
|
+
/**
|
|
9462
|
+
* Lists builts of a GitHub Pages site.
|
|
9463
|
+
*
|
|
9464
|
+
* A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission.
|
|
9465
|
+
*/
|
|
8827
9466
|
listPagesBuilds: {
|
|
8828
9467
|
(params?: RestEndpointMethodTypes["repos"]["listPagesBuilds"]["parameters"]): Promise<RestEndpointMethodTypes["repos"]["listPagesBuilds"]["response"]>;
|
|
8829
9468
|
defaults: RequestInterface["defaults"];
|
|
@@ -8836,7 +9475,7 @@ export declare type RestEndpointMethods = {
|
|
|
8836
9475
|
*
|
|
8837
9476
|
* Note:
|
|
8838
9477
|
* - For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise.
|
|
8839
|
-
* - Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/
|
|
9478
|
+
* - Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of repositories.
|
|
8840
9479
|
*/
|
|
8841
9480
|
listPublic: {
|
|
8842
9481
|
(params?: RestEndpointMethodTypes["repos"]["listPublic"]["parameters"]): Promise<RestEndpointMethodTypes["repos"]["listPublic"]["response"]>;
|
|
@@ -8846,7 +9485,7 @@ export declare type RestEndpointMethods = {
|
|
|
8846
9485
|
}>;
|
|
8847
9486
|
};
|
|
8848
9487
|
/**
|
|
8849
|
-
* Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch,
|
|
9488
|
+
* 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.
|
|
8850
9489
|
*/
|
|
8851
9490
|
listPullRequestsAssociatedWithCommit: {
|
|
8852
9491
|
(params?: RestEndpointMethodTypes["repos"]["listPullRequestsAssociatedWithCommit"]["parameters"]): Promise<RestEndpointMethodTypes["repos"]["listPullRequestsAssociatedWithCommit"]["response"]>;
|
|
@@ -8961,10 +9600,6 @@ export declare type RestEndpointMethods = {
|
|
|
8961
9600
|
* Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
|
|
8962
9601
|
*
|
|
8963
9602
|
* Removes the ability of an app to push to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.
|
|
8964
|
-
*
|
|
8965
|
-
* | Type | Description |
|
|
8966
|
-
* | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
8967
|
-
* | `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |
|
|
8968
9603
|
*/
|
|
8969
9604
|
removeAppAccessRestrictions: {
|
|
8970
9605
|
(params?: RestEndpointMethodTypes["repos"]["removeAppAccessRestrictions"]["parameters"]): Promise<RestEndpointMethodTypes["repos"]["removeAppAccessRestrictions"]["response"]>;
|
|
@@ -9004,10 +9639,6 @@ export declare type RestEndpointMethods = {
|
|
|
9004
9639
|
* Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
|
|
9005
9640
|
*
|
|
9006
9641
|
* Removes the ability of a team to push to this branch. You can also remove push access for child teams.
|
|
9007
|
-
*
|
|
9008
|
-
* | Type | Description |
|
|
9009
|
-
* | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
9010
|
-
* | `array` | Teams that should no longer have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |
|
|
9011
9642
|
*/
|
|
9012
9643
|
removeTeamAccessRestrictions: {
|
|
9013
9644
|
(params?: RestEndpointMethodTypes["repos"]["removeTeamAccessRestrictions"]["parameters"]): Promise<RestEndpointMethodTypes["repos"]["removeTeamAccessRestrictions"]["response"]>;
|
|
@@ -9091,10 +9722,6 @@ export declare type RestEndpointMethods = {
|
|
|
9091
9722
|
* Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
|
|
9092
9723
|
*
|
|
9093
9724
|
* Replaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.
|
|
9094
|
-
*
|
|
9095
|
-
* | Type | Description |
|
|
9096
|
-
* | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
9097
|
-
* | `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |
|
|
9098
9725
|
*/
|
|
9099
9726
|
setAppAccessRestrictions: {
|
|
9100
9727
|
(params?: RestEndpointMethodTypes["repos"]["setAppAccessRestrictions"]["parameters"]): Promise<RestEndpointMethodTypes["repos"]["setAppAccessRestrictions"]["response"]>;
|
|
@@ -9117,10 +9744,6 @@ export declare type RestEndpointMethods = {
|
|
|
9117
9744
|
* Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
|
|
9118
9745
|
*
|
|
9119
9746
|
* Replaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.
|
|
9120
|
-
*
|
|
9121
|
-
* | Type | Description |
|
|
9122
|
-
* | ------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
9123
|
-
* | `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |
|
|
9124
9747
|
*/
|
|
9125
9748
|
setTeamAccessRestrictions: {
|
|
9126
9749
|
(params?: RestEndpointMethodTypes["repos"]["setTeamAccessRestrictions"]["parameters"]): Promise<RestEndpointMethodTypes["repos"]["setTeamAccessRestrictions"]["response"]>;
|
|
@@ -9214,6 +9837,8 @@ export declare type RestEndpointMethods = {
|
|
|
9214
9837
|
};
|
|
9215
9838
|
/**
|
|
9216
9839
|
* Updates information for a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages).
|
|
9840
|
+
*
|
|
9841
|
+
* To use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the `repo` scope or Pages write permission is required. GitHub Apps must have the `administration:write` and `pages:write` permissions.
|
|
9217
9842
|
*/
|
|
9218
9843
|
updateInformationAboutPagesSite: {
|
|
9219
9844
|
(params?: RestEndpointMethodTypes["repos"]["updateInformationAboutPagesSite"]["parameters"]): Promise<RestEndpointMethodTypes["repos"]["updateInformationAboutPagesSite"]["response"]>;
|
|
@@ -9229,6 +9854,16 @@ export declare type RestEndpointMethods = {
|
|
|
9229
9854
|
url: string;
|
|
9230
9855
|
}>;
|
|
9231
9856
|
};
|
|
9857
|
+
/**
|
|
9858
|
+
* Update a ruleset for an organization.
|
|
9859
|
+
*/
|
|
9860
|
+
updateOrgRuleset: {
|
|
9861
|
+
(params?: RestEndpointMethodTypes["repos"]["updateOrgRuleset"]["parameters"]): Promise<RestEndpointMethodTypes["repos"]["updateOrgRuleset"]["response"]>;
|
|
9862
|
+
defaults: RequestInterface["defaults"];
|
|
9863
|
+
endpoint: EndpointInterface<{
|
|
9864
|
+
url: string;
|
|
9865
|
+
}>;
|
|
9866
|
+
};
|
|
9232
9867
|
/**
|
|
9233
9868
|
* Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
|
|
9234
9869
|
*
|
|
@@ -9263,6 +9898,16 @@ export declare type RestEndpointMethods = {
|
|
|
9263
9898
|
url: string;
|
|
9264
9899
|
}>;
|
|
9265
9900
|
};
|
|
9901
|
+
/**
|
|
9902
|
+
* Update a ruleset for a repository.
|
|
9903
|
+
*/
|
|
9904
|
+
updateRepoRuleset: {
|
|
9905
|
+
(params?: RestEndpointMethodTypes["repos"]["updateRepoRuleset"]["parameters"]): Promise<RestEndpointMethodTypes["repos"]["updateRepoRuleset"]["response"]>;
|
|
9906
|
+
defaults: RequestInterface["defaults"];
|
|
9907
|
+
endpoint: EndpointInterface<{
|
|
9908
|
+
url: string;
|
|
9909
|
+
}>;
|
|
9910
|
+
};
|
|
9266
9911
|
/**
|
|
9267
9912
|
* Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
|
|
9268
9913
|
*
|
|
@@ -9312,7 +9957,7 @@ export declare type RestEndpointMethods = {
|
|
|
9312
9957
|
};
|
|
9313
9958
|
/**
|
|
9314
9959
|
* This endpoint makes use of [a Hypermedia relation](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in
|
|
9315
|
-
* the response of the [Create a release endpoint](https://docs.github.com/rest/
|
|
9960
|
+
* the response of the [Create a release endpoint](https://docs.github.com/rest/releases/releases#create-a-release) to upload a release asset.
|
|
9316
9961
|
*
|
|
9317
9962
|
* You need to use an HTTP client which supports [SNI](http://en.wikipedia.org/wiki/Server_Name_Indication) to make calls to this endpoint.
|
|
9318
9963
|
*
|
|
@@ -9328,6 +9973,7 @@ export declare type RestEndpointMethods = {
|
|
|
9328
9973
|
* **Notes:**
|
|
9329
9974
|
* * GitHub renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The "[List assets for a release](https://docs.github.com/rest/reference/repos#list-assets-for-a-release)"
|
|
9330
9975
|
* endpoint lists the renamed filenames. For more information and help, contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api).
|
|
9976
|
+
* * To find the `release_id` query the [`GET /repos/{owner}/{repo}/releases/latest` endpoint](https://docs.github.com/rest/releases/releases#get-the-latest-release).
|
|
9331
9977
|
* * If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset.
|
|
9332
9978
|
*/
|
|
9333
9979
|
uploadReleaseAsset: {
|
|
@@ -9358,6 +10004,8 @@ export declare type RestEndpointMethods = {
|
|
|
9358
10004
|
* * Only files smaller than 384 KB are searchable.
|
|
9359
10005
|
* * You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazing
|
|
9360
10006
|
* language:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is.
|
|
10007
|
+
*
|
|
10008
|
+
* This endpoint requires you to authenticate and limits you to 10 requests per minute.
|
|
9361
10009
|
*/
|
|
9362
10010
|
code: {
|
|
9363
10011
|
(params?: RestEndpointMethodTypes["search"]["code"]["parameters"]): Promise<RestEndpointMethodTypes["search"]["code"]["response"]>;
|
|
@@ -9367,7 +10015,7 @@ export declare type RestEndpointMethods = {
|
|
|
9367
10015
|
}>;
|
|
9368
10016
|
};
|
|
9369
10017
|
/**
|
|
9370
|
-
* Find commits via various criteria on the default branch (usually `
|
|
10018
|
+
* Find commits via various criteria on the default branch (usually `main`). This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination).
|
|
9371
10019
|
*
|
|
9372
10020
|
* When searching for commits, you can get text match metadata for the **message** field when you provide the `text-match` media type. For more details about how to receive highlighted search results, see [Text match
|
|
9373
10021
|
* metadata](https://docs.github.com/rest/reference/search#text-match-metadata).
|
|
@@ -9560,12 +10208,82 @@ export declare type RestEndpointMethods = {
|
|
|
9560
10208
|
}>;
|
|
9561
10209
|
};
|
|
9562
10210
|
};
|
|
9563
|
-
|
|
10211
|
+
securityAdvisories: {
|
|
9564
10212
|
/**
|
|
9565
|
-
*
|
|
10213
|
+
* Report a security vulnerability to the maintainers of the repository.
|
|
10214
|
+
* See "[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)" for more information about private vulnerability reporting.
|
|
10215
|
+
*/
|
|
10216
|
+
createPrivateVulnerabilityReport: {
|
|
10217
|
+
(params?: RestEndpointMethodTypes["securityAdvisories"]["createPrivateVulnerabilityReport"]["parameters"]): Promise<RestEndpointMethodTypes["securityAdvisories"]["createPrivateVulnerabilityReport"]["response"]>;
|
|
10218
|
+
defaults: RequestInterface["defaults"];
|
|
10219
|
+
endpoint: EndpointInterface<{
|
|
10220
|
+
url: string;
|
|
10221
|
+
}>;
|
|
10222
|
+
};
|
|
10223
|
+
/**
|
|
10224
|
+
* Creates a new repository security advisory.
|
|
10225
|
+
* You must authenticate using an access token with the `repo` scope or `repository_advisories:write` permission to use this endpoint.
|
|
10226
|
+
*
|
|
10227
|
+
* In order to create a draft repository security advisory, you must be a security manager or administrator of that repository.
|
|
10228
|
+
*/
|
|
10229
|
+
createRepositoryAdvisory: {
|
|
10230
|
+
(params?: RestEndpointMethodTypes["securityAdvisories"]["createRepositoryAdvisory"]["parameters"]): Promise<RestEndpointMethodTypes["securityAdvisories"]["createRepositoryAdvisory"]["response"]>;
|
|
10231
|
+
defaults: RequestInterface["defaults"];
|
|
10232
|
+
endpoint: EndpointInterface<{
|
|
10233
|
+
url: string;
|
|
10234
|
+
}>;
|
|
10235
|
+
};
|
|
10236
|
+
/**
|
|
10237
|
+
* Get a repository security advisory using its GitHub Security Advisory (GHSA) identifier.
|
|
10238
|
+
* You can access any published security advisory on a public repository.
|
|
10239
|
+
* You must authenticate using an access token with the `repo` scope or `repository_advisories:read` permission
|
|
10240
|
+
* in order to get a published security advisory in a private repository, or any unpublished security advisory that you have access to.
|
|
10241
|
+
*
|
|
10242
|
+
* You can access an unpublished security advisory from a repository if you are a security manager or administrator of that repository, or if you are a
|
|
10243
|
+
* collaborator on the security advisory.
|
|
10244
|
+
*/
|
|
10245
|
+
getRepositoryAdvisory: {
|
|
10246
|
+
(params?: RestEndpointMethodTypes["securityAdvisories"]["getRepositoryAdvisory"]["parameters"]): Promise<RestEndpointMethodTypes["securityAdvisories"]["getRepositoryAdvisory"]["response"]>;
|
|
10247
|
+
defaults: RequestInterface["defaults"];
|
|
10248
|
+
endpoint: EndpointInterface<{
|
|
10249
|
+
url: string;
|
|
10250
|
+
}>;
|
|
10251
|
+
};
|
|
10252
|
+
/**
|
|
10253
|
+
* Lists security advisories in a repository.
|
|
10254
|
+
* You must authenticate using an access token with the `repo` scope or `repository_advisories:read` permission
|
|
10255
|
+
* in order to get published security advisories in a private repository, or any unpublished security advisories that you have access to.
|
|
10256
|
+
*
|
|
10257
|
+
* You can access unpublished security advisories from a repository if you are a security manager or administrator of that repository, or if you are a collaborator on any security advisory.
|
|
10258
|
+
*/
|
|
10259
|
+
listRepositoryAdvisories: {
|
|
10260
|
+
(params?: RestEndpointMethodTypes["securityAdvisories"]["listRepositoryAdvisories"]["parameters"]): Promise<RestEndpointMethodTypes["securityAdvisories"]["listRepositoryAdvisories"]["response"]>;
|
|
10261
|
+
defaults: RequestInterface["defaults"];
|
|
10262
|
+
endpoint: EndpointInterface<{
|
|
10263
|
+
url: string;
|
|
10264
|
+
}>;
|
|
10265
|
+
};
|
|
10266
|
+
/**
|
|
10267
|
+
* Update a repository security advisory using its GitHub Security Advisory (GHSA) identifier.
|
|
10268
|
+
* You must authenticate using an access token with the `repo` scope or `repository_advisories:write` permission to use this endpoint.
|
|
9566
10269
|
*
|
|
10270
|
+
* In order to update any security advisory, you must be a security manager or administrator of that repository,
|
|
10271
|
+
* or a collaborator on the repository security advisory.
|
|
10272
|
+
*/
|
|
10273
|
+
updateRepositoryAdvisory: {
|
|
10274
|
+
(params?: RestEndpointMethodTypes["securityAdvisories"]["updateRepositoryAdvisory"]["parameters"]): Promise<RestEndpointMethodTypes["securityAdvisories"]["updateRepositoryAdvisory"]["response"]>;
|
|
10275
|
+
defaults: RequestInterface["defaults"];
|
|
10276
|
+
endpoint: EndpointInterface<{
|
|
10277
|
+
url: string;
|
|
10278
|
+
}>;
|
|
10279
|
+
};
|
|
10280
|
+
};
|
|
10281
|
+
teams: {
|
|
10282
|
+
/**
|
|
9567
10283
|
* Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.
|
|
9568
10284
|
*
|
|
10285
|
+
* Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
|
|
10286
|
+
*
|
|
9569
10287
|
* **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)."
|
|
9570
10288
|
*
|
|
9571
10289
|
* An organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the "pending" state until the person accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team.
|
|
@@ -9598,7 +10316,7 @@ export declare type RestEndpointMethods = {
|
|
|
9598
10316
|
*
|
|
9599
10317
|
* **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.
|
|
9600
10318
|
*
|
|
9601
|
-
* For more information about the permission levels, see "[Repository permission levels for an organization](https://docs.github.com/
|
|
10319
|
+
* For more information about the permission levels, see "[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)".
|
|
9602
10320
|
*/
|
|
9603
10321
|
addOrUpdateRepoPermissionsInOrg: {
|
|
9604
10322
|
(params?: RestEndpointMethodTypes["teams"]["addOrUpdateRepoPermissionsInOrg"]["parameters"]): Promise<RestEndpointMethodTypes["teams"]["addOrUpdateRepoPermissionsInOrg"]["response"]>;
|
|
@@ -9636,9 +10354,9 @@ export declare type RestEndpointMethods = {
|
|
|
9636
10354
|
}>;
|
|
9637
10355
|
};
|
|
9638
10356
|
/**
|
|
9639
|
-
* To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see "[Setting team creation permissions](https://docs.github.com/
|
|
10357
|
+
* To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see "[Setting team creation permissions](https://docs.github.com/articles/setting-team-creation-permissions-in-your-organization)."
|
|
9640
10358
|
*
|
|
9641
|
-
* When you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see "[About teams](https://docs.github.com/
|
|
10359
|
+
* When you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see "[About teams](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/about-teams)".
|
|
9642
10360
|
*/
|
|
9643
10361
|
create: {
|
|
9644
10362
|
(params?: RestEndpointMethodTypes["teams"]["create"]["parameters"]): Promise<RestEndpointMethodTypes["teams"]["create"]["response"]>;
|
|
@@ -9650,7 +10368,7 @@ export declare type RestEndpointMethods = {
|
|
|
9650
10368
|
/**
|
|
9651
10369
|
* Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
|
|
9652
10370
|
*
|
|
9653
|
-
* This endpoint triggers [notifications](https://docs.github.com/
|
|
10371
|
+
* This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details.
|
|
9654
10372
|
*
|
|
9655
10373
|
* **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.
|
|
9656
10374
|
*/
|
|
@@ -9664,7 +10382,7 @@ export declare type RestEndpointMethods = {
|
|
|
9664
10382
|
/**
|
|
9665
10383
|
* Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
|
|
9666
10384
|
*
|
|
9667
|
-
* This endpoint triggers [notifications](https://docs.github.com/
|
|
10385
|
+
* This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details.
|
|
9668
10386
|
*
|
|
9669
10387
|
* **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`.
|
|
9670
10388
|
*/
|
|
@@ -9714,7 +10432,7 @@ export declare type RestEndpointMethods = {
|
|
|
9714
10432
|
}>;
|
|
9715
10433
|
};
|
|
9716
10434
|
/**
|
|
9717
|
-
* Gets a team using the team's `slug`.
|
|
10435
|
+
* Gets a team using the team's `slug`. To create the `slug`, GitHub replaces special characters in the `name` string, changes all words to lowercase, and replaces spaces with a `-` separator. For example, `"My TEam Näme"` would become `my-team-name`.
|
|
9718
10436
|
*
|
|
9719
10437
|
* **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`.
|
|
9720
10438
|
*/
|
|
@@ -9815,7 +10533,7 @@ export declare type RestEndpointMethods = {
|
|
|
9815
10533
|
}>;
|
|
9816
10534
|
};
|
|
9817
10535
|
/**
|
|
9818
|
-
* List all of the teams across all of the organizations to which the authenticated user belongs. This method requires `user`, `repo`, or `read:org` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/) when authenticating via [OAuth](https://docs.github.com/apps/building-oauth-apps/).
|
|
10536
|
+
* List all of the teams across all of the organizations to which the authenticated user belongs. This method requires `user`, `repo`, or `read:org` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/) when authenticating via [OAuth](https://docs.github.com/apps/building-oauth-apps/). When using a fine-grained personal access token, the resource owner of the token [must be a single organization](https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token#fine-grained-personal-access-tokens), and have at least read-only member organization permissions. The response payload only contains the teams from a single organization when using a fine-grained personal access token.
|
|
9819
10537
|
*/
|
|
9820
10538
|
listForAuthenticatedUser: {
|
|
9821
10539
|
(params?: RestEndpointMethodTypes["teams"]["listForAuthenticatedUser"]["parameters"]): Promise<RestEndpointMethodTypes["teams"]["listForAuthenticatedUser"]["response"]>;
|
|
@@ -9873,10 +10591,10 @@ export declare type RestEndpointMethods = {
|
|
|
9873
10591
|
}>;
|
|
9874
10592
|
};
|
|
9875
10593
|
/**
|
|
9876
|
-
* Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
|
|
9877
|
-
*
|
|
9878
10594
|
* To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.
|
|
9879
10595
|
*
|
|
10596
|
+
* Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
|
|
10597
|
+
*
|
|
9880
10598
|
* **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)."
|
|
9881
10599
|
*
|
|
9882
10600
|
* **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`.
|
|
@@ -9971,6 +10689,16 @@ export declare type RestEndpointMethods = {
|
|
|
9971
10689
|
url: string;
|
|
9972
10690
|
}>;
|
|
9973
10691
|
};
|
|
10692
|
+
/**
|
|
10693
|
+
* Add one or more social accounts to the authenticated user's profile. This endpoint is accessible with the `user` scope.
|
|
10694
|
+
*/
|
|
10695
|
+
addSocialAccountForAuthenticatedUser: {
|
|
10696
|
+
(params?: RestEndpointMethodTypes["users"]["addSocialAccountForAuthenticatedUser"]["parameters"]): Promise<RestEndpointMethodTypes["users"]["addSocialAccountForAuthenticatedUser"]["response"]>;
|
|
10697
|
+
defaults: RequestInterface["defaults"];
|
|
10698
|
+
endpoint: EndpointInterface<{
|
|
10699
|
+
url: string;
|
|
10700
|
+
}>;
|
|
10701
|
+
};
|
|
9974
10702
|
block: {
|
|
9975
10703
|
(params?: RestEndpointMethodTypes["users"]["block"]["parameters"]): Promise<RestEndpointMethodTypes["users"]["block"]["response"]>;
|
|
9976
10704
|
defaults: RequestInterface["defaults"];
|
|
@@ -10114,6 +10842,16 @@ export declare type RestEndpointMethods = {
|
|
|
10114
10842
|
url: string;
|
|
10115
10843
|
}>;
|
|
10116
10844
|
};
|
|
10845
|
+
/**
|
|
10846
|
+
* Deletes one or more social accounts from the authenticated user's profile. This endpoint is accessible with the `user` scope.
|
|
10847
|
+
*/
|
|
10848
|
+
deleteSocialAccountForAuthenticatedUser: {
|
|
10849
|
+
(params?: RestEndpointMethodTypes["users"]["deleteSocialAccountForAuthenticatedUser"]["parameters"]): Promise<RestEndpointMethodTypes["users"]["deleteSocialAccountForAuthenticatedUser"]["response"]>;
|
|
10850
|
+
defaults: RequestInterface["defaults"];
|
|
10851
|
+
endpoint: EndpointInterface<{
|
|
10852
|
+
url: string;
|
|
10853
|
+
}>;
|
|
10854
|
+
};
|
|
10117
10855
|
/**
|
|
10118
10856
|
* Deletes an SSH signing key from the authenticated user's GitHub account. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `admin:ssh_signing_key` scope. For more information, see "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)."
|
|
10119
10857
|
*/
|
|
@@ -10236,7 +10974,7 @@ export declare type RestEndpointMethods = {
|
|
|
10236
10974
|
/**
|
|
10237
10975
|
* Lists all users, in the order that they signed up on GitHub. This list includes personal user accounts and organization accounts.
|
|
10238
10976
|
*
|
|
10239
|
-
* Note: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/
|
|
10977
|
+
* Note: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of users.
|
|
10240
10978
|
*/
|
|
10241
10979
|
list: {
|
|
10242
10980
|
(params?: RestEndpointMethodTypes["users"]["list"]["parameters"]): Promise<RestEndpointMethodTypes["users"]["list"]["response"]>;
|
|
@@ -10421,6 +11159,26 @@ export declare type RestEndpointMethods = {
|
|
|
10421
11159
|
url: string;
|
|
10422
11160
|
}>;
|
|
10423
11161
|
};
|
|
11162
|
+
/**
|
|
11163
|
+
* Lists all of your social accounts.
|
|
11164
|
+
*/
|
|
11165
|
+
listSocialAccountsForAuthenticatedUser: {
|
|
11166
|
+
(params?: RestEndpointMethodTypes["users"]["listSocialAccountsForAuthenticatedUser"]["parameters"]): Promise<RestEndpointMethodTypes["users"]["listSocialAccountsForAuthenticatedUser"]["response"]>;
|
|
11167
|
+
defaults: RequestInterface["defaults"];
|
|
11168
|
+
endpoint: EndpointInterface<{
|
|
11169
|
+
url: string;
|
|
11170
|
+
}>;
|
|
11171
|
+
};
|
|
11172
|
+
/**
|
|
11173
|
+
* Lists social media accounts for a user. This endpoint is accessible by anyone.
|
|
11174
|
+
*/
|
|
11175
|
+
listSocialAccountsForUser: {
|
|
11176
|
+
(params?: RestEndpointMethodTypes["users"]["listSocialAccountsForUser"]["parameters"]): Promise<RestEndpointMethodTypes["users"]["listSocialAccountsForUser"]["response"]>;
|
|
11177
|
+
defaults: RequestInterface["defaults"];
|
|
11178
|
+
endpoint: EndpointInterface<{
|
|
11179
|
+
url: string;
|
|
11180
|
+
}>;
|
|
11181
|
+
};
|
|
10424
11182
|
/**
|
|
10425
11183
|
* Lists the SSH signing keys for the authenticated user's GitHub account. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `read:ssh_signing_key` scope. For more information, see "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)."
|
|
10426
11184
|
*/
|